event

Documentation

Index

• Variables
• type ErrEventReqChNotSet
  • func (e *ErrEventReqChNotSet) Error() string
• type ErrNewEvent
  • func (e *ErrNewEvent) Error() string
• type ErrUnregisteredEvent
  • func (e *ErrUnregisteredEvent) Error() string
• type Event
  • func (e *Event) GetPayload() interface{}
  • func (e *Event) Name() string
  • func (e *Event) Publish(nc *nats.EncodedConn) error
• type EventAccountCreatedPayload
• type EventInfo
• type EventMeta
• type EventName
• type EventPaymentPayload
• type EventPolicyUpdatedPayload
• type EventProductReservedPayload
• type EventPublisher
  • func NewEventPublisher() *EventPublisher
  • func (ep *EventPublisher) AddEvent(e IEvent, err error) error
  • func (ep *EventPublisher) GetEventNames() (names []string)
  • func (ep *EventPublisher) Publish(nc *nats.EncodedConn) error
• type EventRegistry
  • func (er *EventRegistry) GetEventInfo(name EventName) (EventInfo, error)
• type EventUpsertPolicyPayload
• type IEvent
  • func NewEvent(ctx context.Context, name EventName, payload interface{}) (IEvent, error)

Variables

var (
	ErrNilNATSConnObj   = errors.New("nil nats conn obj received")
	ErrInvalidPayload   = errors.New("invalid payload")
	ErrUnsupportedEvent = errors.New("unsupported event")
)

Errors of event package

var Registry = &EventRegistry{
	Registry: make(map[EventName]EventInfo),
}

Registry is the service EventRegistry where all the active events which are to be fired or handled must register themselves

Types

type ErrEventReqChNotSet

type ErrEventReqChNotSet struct {
	Name EventName
}

func (*ErrEventReqChNotSet) Error

func (e *ErrEventReqChNotSet) Error() string

type ErrNewEvent

type ErrNewEvent struct {
	Name EventName
}

func (*ErrNewEvent) Error

func (e *ErrNewEvent) Error() string

type ErrUnregisteredEvent

type ErrUnregisteredEvent struct {
	Name EventName
}

func (*ErrUnregisteredEvent) Error

func (e *ErrUnregisteredEvent) Error() string

type Event

type Event struct {
	Meta    EventMeta   `json:"meta"`
	Payload interface{} `json:"payload"`
}

func (*Event) GetPayload

func (e *Event) GetPayload() interface{}

func (*Event) Name

func (e *Event) Name() string

func (*Event) Publish

func (e *Event) Publish(nc *nats.EncodedConn) error

type EventAccountCreatedPayload

type EventAccountCreatedPayload struct {
	AccntID uint   `json:"accnt_id"`
	Role    string `json:"role"`
}

type EventInfo

type EventInfo struct {
	ReqChan  string
	RespChan string
	// contains filtered or unexported fields
}

type EventMeta

type EventMeta struct {
	Version   string    `json:"version"`
	Source    string    `json:"source"`
	Time      time.Time `json:"time"`
	Name      string    `json:"name"`
	ID        string    `json:"id"`
	RequestID string    `json:"req_id"`
}

type EventName

type EventName string

const EventAccountCreated EventName = "EventAccountCreated"

const EventPayment EventName = "EventPayment"

const EventPolicyUpdated EventName = "EventPolicyUpdated"

const EventProductReserved EventName = "EventProductReserved"

const EventUpsertPolicy EventName = "EventUpsertPolicy"

type EventPaymentPayload

type EventPaymentPayload struct {
	OrderID uuid.UUID `json:"order_id"`
	AccntID uint      `json:"account_id"`
	Status  string    `json:"status"` // can be on of [payment_successful / payment_failed]
}

type EventPolicyUpdatedPayload

type EventPolicyUpdatedPayload struct {
	Method       string `json:"method"` // could be put/delete
	Sub          string `json:"subject"`
	ResourceType string `json:"resource_type"`
	ResourceID   string `json:"resource_id"`
	Action       string `json:"action"`
}

type EventProductReservedPayload

type EventProductReservedPayload struct {
	OrderID uuid.UUID `json:"order_id"`
	AccntID uint      `json:"account_id"`
	Payble  float32   `json:"payble"`
}

type EventPublisher

type EventPublisher struct {
	// contains filtered or unexported fields
}

EventPublisher makes it easy to add events and send them all at once

func NewEventPublisher

func NewEventPublisher() *EventPublisher

func (*EventPublisher) AddEvent

func (ep *EventPublisher) AddEvent(e IEvent, err error) error

func (*EventPublisher) GetEventNames

func (ep *EventPublisher) GetEventNames() (names []string)

func (*EventPublisher) Publish

func (ep *EventPublisher) Publish(nc *nats.EncodedConn) error

Publish publishes the added events to registered NATS subjects if error occurs while publishing any event, the publisher returns the error immediately instead of try publishing other events

type EventRegistry

type EventRegistry struct {
	Registry map[EventName]EventInfo
}

Registry holds all the event name and their transport details mapping It helps in verifying the event name and getting their request/response channel

func (*EventRegistry) GetEventInfo

func (er *EventRegistry) GetEventInfo(name EventName) (EventInfo, error)

type EventUpsertPolicyPayload

type EventUpsertPolicyPayload struct {
	Sub          string `json:"subject"`
	ResourceType string `json:"resource_type"`
	ResourceID   string `json:"resource_id"`
	Action       string `json:"action"`
}

type IEvent

type IEvent interface {
	Name() string
	GetPayload() interface{}
	Publish(*nats.EncodedConn) error
}

func NewEvent

func NewEvent(ctx context.Context, name EventName, payload interface{}) (IEvent, error)

NewEvent is the factory to generate all the event