listeners

Documentation

Index

• Constants
• type Container
  • func NewListenersContainer(ctx context.Context, logger *zap.Logger) Container
• type Listener
  • func NewListener(msgType network.NetworkMsg) *Listener
  • func (l *Listener) DecidedChan() chan *proto.SignedMessage
  • func (l *Listener) MsgChan() chan *proto.SignedMessage
  • func (l *Listener) SigChan() chan *proto.SignedMessage
  • func (l *Listener) SyncChan() chan *network.SyncChanObj

Constants

const (
	// MsgChanSize is the buffer size of the message channel
	MsgChanSize = 128
)

Types

type Container

type Container interface {
	// Register registers a new listener and returns a function for de-registration
	Register(l *Listener) func()
	// GetListeners returns all active listeners
	GetListeners(msgType network.NetworkMsg) []*Listener
}

Container is an interface for managing internal listeners

func NewListenersContainer

func NewListenersContainer(ctx context.Context, logger *zap.Logger) Container

NewListenersContainer creates a new instance of listeners container

type Listener

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

Listener represents an internal listener

func NewListener

func NewListener(msgType network.NetworkMsg) *Listener

NewListener creates a new instance of listener

func (*Listener) DecidedChan

func (l *Listener) DecidedChan() chan *proto.SignedMessage

DecidedChan returns the underlying decided channel

func (*Listener) MsgChan

func (l *Listener) MsgChan() chan *proto.SignedMessage

MsgChan returns the underlying msg channel

func (*Listener) SigChan

func (l *Listener) SigChan() chan *proto.SignedMessage

SigChan returns the underlying signature channel

func (*Listener) SyncChan

func (l *Listener) SyncChan() chan *network.SyncChanObj

SyncChan returns the underlying sync channel