event

Documentation

Index

• Constants
• func GenSubID() string
• func QueryForEventID(eventID string) query.Queryable
• type Emitter
  • func NewEmitter() *Emitter
  • func (em *Emitter) Publish(ctx context.Context, message interface{}, tags query.Tagged) error
  • func (em *Emitter) SetLogger(logger *logging.Logger)
  • func (em *Emitter) Shutdown(ctx context.Context) error
  • func (em *Emitter) Subscribe(ctx context.Context, subscriber string, queryable query.Queryable, ...) (<-chan interface{}, error)
  • func (em *Emitter) Unsubscribe(ctx context.Context, subscriber string, queryable query.Queryable) error
  • func (em *Emitter) UnsubscribeAll(ctx context.Context, subscriber string) error
• type EventID
  • func (eid EventID) Matches(tags query.Tagged) bool
  • func (eid EventID) String() string

Constants

const (
	EventTypeKey   = "EventType"
	EventIDKey     = "EventID"
	MessageTypeKey = "MessageType"
	TxHashKey      = "TxHash"
	HeightKey      = "Height"
	IndexKey       = "Index"
	StackDepthKey  = "StackDepth"
	AddressKey     = "Address"
)

const DefaultEventBufferCapacity = 2 << 10

Functions

func GenSubID

func GenSubID() string

func QueryForEventID

func QueryForEventID(eventID string) query.Queryable

Get a query that matches events with a specific eventID

Types

type Emitter

type Emitter struct {
	common.BaseService
	// contains filtered or unexported fields
}

Emitter has methods for working with events

func NewEmitter

func NewEmitter() *Emitter

NewEmitter initializes an emitter struct with a pubsubServer

func (*Emitter) Publish

func (em *Emitter) Publish(ctx context.Context, message interface{}, tags query.Tagged) error

Publish tells the emitter to publish with the given message and tags

func (*Emitter) SetLogger

func (em *Emitter) SetLogger(logger *logging.Logger)

SetLogger attaches a log handler to this emitter

func (*Emitter) Shutdown

func (em *Emitter) Shutdown(ctx context.Context) error

Shutdown stops the pubsubServer

func (*Emitter) Subscribe

func (em *Emitter) Subscribe(ctx context.Context, subscriber string, queryable query.Queryable, bufferSize int) (<-chan interface{}, error)

Subscribe tells the emitter to listen for messages on the given query

func (*Emitter) Unsubscribe

func (em *Emitter) Unsubscribe(ctx context.Context, subscriber string, queryable query.Queryable) error

Unsubscribe tells the emitter to stop listening for said messages

func (*Emitter) UnsubscribeAll

func (em *Emitter) UnsubscribeAll(ctx context.Context, subscriber string) error

UnsubscribeAll just stop listening for all messages

type EventID

type EventID string

func (EventID) Matches

func (eid EventID) Matches(tags query.Tagged) bool

func (EventID) String

func (eid EventID) String() string