event

Documentation

Index

• Constants
• func GenSubID() string
• func QueryForEventID(eventID string) *query.Builder
• type Emitter
  • func NewEmitter(logger *logging.Logger) Emitter
• type Publisher
  • func NewNoOpPublisher() Publisher
• type PublisherFunc
  • func (pf PublisherFunc) Publish(ctx context.Context, message interface{}, tags query.Tagged) error
• type Subscribable

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.Builder

Get a query that matches events with a specific eventID

Types

type Emitter

type Emitter interface {
	Subscribable
	Publisher
	process.Process
}

func NewEmitter

func NewEmitter(logger *logging.Logger) Emitter

type Publisher

type Publisher interface {
	Publish(ctx context.Context, message interface{}, tag query.Tagged) error
}

func NewNoOpPublisher

func NewNoOpPublisher() Publisher

NoOpPublisher

type PublisherFunc

type PublisherFunc func(ctx context.Context, message interface{}, tags query.Tagged) error

func (PublisherFunc) Publish

func (pf PublisherFunc) Publish(ctx context.Context, message interface{}, tags query.Tagged) error

type Subscribable

type Subscribable interface {
	// Subscribe to all events matching query, which is a valid tmlibs Query. Blocking the out channel blocks the entire
	// pubsub.
	Subscribe(ctx context.Context, subscriber string, queryable query.Queryable, bufferSize int) (out <-chan interface{}, err error)
	// Unsubscribe subscriber from a specific query string. Note the subscribe channel must be drained.
	Unsubscribe(ctx context.Context, subscriber string, queryable query.Queryable) error
	UnsubscribeAll(ctx context.Context, subscriber string) error
}

TODO: manage the creation, closing, and draining of channels behind the interface rather than only closing. stop one subscriber from blocking everything!