event

package

v0.34.4 Latest Latest Go to latest Published: Jul 23, 2021 License: Apache-2.0 Imports: 9 Imported by: 40

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hyperledger/burrow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GenSubID() string
func QueryForEventID(eventID string) query.Queryable
type Emitter
- func NewEmitter() *Emitter
type EventID

Constants ¶

View Source

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

View Source

const DefaultEventBufferCapacity = 2 << 10

Variables ¶

This section is empty.

Functions ¶

func GenSubID ¶ added in v0.20.0

func GenSubID() string

func QueryForEventID ¶ added in v0.18.0

func QueryForEventID(eventID string) query.Queryable

Get a query that matches events with a specific eventID

Types ¶

type Emitter ¶ added in v0.18.0

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

Emitter has methods for working with events

func NewEmitter ¶ added in v0.18.0

func NewEmitter() *Emitter

NewEmitter initializes an emitter struct with a pubsubServer

func (*Emitter) Publish ¶ added in v0.25.0

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 ¶ added in v0.25.0

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

SetLogger attaches a log handler to this emitter

func (*Emitter) Shutdown ¶ added in v0.25.0

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

Shutdown stops the pubsubServer

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 ¶ added in v0.25.0

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 ¶ added in v0.25.0

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

UnsubscribeAll just stop listening for all messages

type EventID ¶ added in v0.24.0

type EventID string

func (EventID) MatchError ¶ added in v0.28.0

func (eid EventID) MatchError() error

func (EventID) Matches ¶ added in v0.24.0

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

func (EventID) String ¶ added in v0.24.0

func (eid EventID) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
pubsub This package was extracted from Tendermint Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).	This package was extracted from Tendermint Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).
query Package query provides a parser for a custom query format: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar.	Package query provides a parser for a custom query format: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL