triggers

Documentation

Index

• type Acceptor
• type EventDispatcher
  • func (ed *EventDispatcher) Accept(ctx *snow.Context, containerID ids.ID, container []byte) error
  • func (ed *EventDispatcher) Deregister(identifier string) error
  • func (ed *EventDispatcher) DeregisterChain(chainID ids.ID, identifier string) error
  • func (ed *EventDispatcher) Initialize(log logging.Logger)
  • func (ed *EventDispatcher) Issue(ctx *snow.Context, containerID ids.ID, container []byte) error
  • func (ed *EventDispatcher) Register(identifier string, handler interface{}) error
  • func (ed *EventDispatcher) RegisterChain(chainID ids.ID, identifier string, handlerFunc interface{}, dieOnError bool) error
  • func (ed *EventDispatcher) Reject(ctx *snow.Context, containerID ids.ID, container []byte) error
• type Issuer
• type Rejector

Types

type Acceptor

type Acceptor interface {
	Accept(ctx *snow.Context, containerID ids.ID, container []byte) error
}

Acceptor is implemented when a struct is monitoring if a message is accepted

type EventDispatcher

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

EventDispatcher receives events from consensus and dispatches the events to triggers

func (*EventDispatcher) Accept

func (ed *EventDispatcher) Accept(ctx *snow.Context, containerID ids.ID, container []byte) error

Accept is called when a transaction or block is accepted. If the returned error is non-nil, the chain associated with [ctx] should shut down and not commit [container] or any other container to its database as accepted.

func (*EventDispatcher) Deregister

func (ed *EventDispatcher) Deregister(identifier string) error

Deregister removes a handler from the system

func (*EventDispatcher) DeregisterChain

func (ed *EventDispatcher) DeregisterChain(chainID ids.ID, identifier string) error

DeregisterChain removes a chain handler from the system

func (*EventDispatcher) Initialize

func (ed *EventDispatcher) Initialize(log logging.Logger)

Initialize creates the EventDispatcher's initial values

func (*EventDispatcher) Issue

func (ed *EventDispatcher) Issue(ctx *snow.Context, containerID ids.ID, container []byte) error

Issue is called when a transaction or block is issued

func (*EventDispatcher) Register

func (ed *EventDispatcher) Register(identifier string, handler interface{}) error

Register places a new handler into the system

func (*EventDispatcher) RegisterChain

func (ed *EventDispatcher) RegisterChain(chainID ids.ID, identifier string, handlerFunc interface{}, dieOnError bool) error

RegisterChain causes [handlerFunc] to be invoked every time a container is issued, accepted or rejected on chain [chainID]. [handlerFunc] should implement at least one of Acceptor, Rejector, Issuer. If [dieOnError], chain [chainID] stops if [handler].Accept is invoked and returns a non-nil error.

func (*EventDispatcher) Reject

func (ed *EventDispatcher) Reject(ctx *snow.Context, containerID ids.ID, container []byte) error

Reject is called when a transaction or block is rejected

type Issuer

type Issuer interface {
	Issue(ctx *snow.Context, containerID ids.ID, container []byte) error
}

Issuer is implemented when a struct is monitoring if a message is issued

type Rejector

type Rejector interface {
	Reject(ctx *snow.Context, containerID ids.ID, container []byte) error
}

Rejector is implemented when a struct is monitoring if a message is rejected