committee

Documentation

Index

• Constants
• type Node
  • func NewNode(commonNode *committee.Node, commonCfg commonWorker.Config, ...) (*Node, error)
  • func (n *Node) Cleanup()
  • func (n *Node) GetStatus(ctx context.Context) (*api.Status, error)
  • func (n *Node) HandleEpochTransitionLocked(epoch *committee.EpochSnapshot)
  • func (n *Node) HandleNewBlockEarlyLocked(blk *block.Block)
  • func (n *Node) HandleNewBlockLocked(blk *block.Block)
  • func (n *Node) HandleNewEventLocked(ev *roothash.Event)
  • func (n *Node) HandlePeerTx(ctx context.Context, tx []byte) error
  • func (n *Node) HandleRuntimeHostEventLocked(ev *host.Event)
  • func (n *Node) Initialized() <-chan struct{}
  • func (n *Node) Name() string
  • func (n *Node) Quit() <-chan struct{}
  • func (n *Node) Start() error
  • func (n *Node) Stop()
  • func (n *Node) WatchStateTransitions() (<-chan NodeState, *pubsub.Subscription)
• type NodeState
• type StateName
• type StateNotReady
  • func (s StateNotReady) Name() StateName
  • func (s StateNotReady) String() string
• type StateProcessingBatch
  • func (s StateProcessingBatch) Name() StateName
  • func (s StateProcessingBatch) String() string
• type StateWaitingForBatch
  • func (s StateWaitingForBatch) Name() StateName
  • func (s StateWaitingForBatch) String() string
• type StateWaitingForBlock
  • func (s StateWaitingForBlock) Name() StateName
  • func (s StateWaitingForBlock) String() string
• type StateWaitingForEvent
  • func (s StateWaitingForEvent) Name() StateName
  • func (s StateWaitingForEvent) String() string
• type StateWaitingForFinalize
  • func (s StateWaitingForFinalize) Name() StateName
  • func (s StateWaitingForFinalize) String() string
• type StateWaitingForTxs
  • func (s StateWaitingForTxs) Name() StateName
  • func (s StateWaitingForTxs) String() string

Constants

const (
	// NotReady is the name of StateNotReady.
	NotReady StateName = "NotReady"
	// WaitingForBatch is the name of StateWaitingForBatch.
	WaitingForBatch = "WaitingForBatch"
	// WaitingForBlock is the name of StateWaitingForBlock.
	WaitingForBlock = "WaitingForBlock"
	// WaitingForEvent is the name of StateWaitingForEvent.
	WaitingForEvent = "WaitingForEvent"
	// WaitingForTxs is the name of the StateWaitingForTxs.
	WaitingForTxs = "WaitingForTxs"
	// ProcessingBatch is the name of StateProcessingBatch.
	ProcessingBatch = "ProcessingBatch"
	// WaitingForFinalize is the name of StateWaitingForFinalize.
	WaitingForFinalize = "WaitingForFinalize"
)

Types

type Node

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

Node is a committee node.

func NewNode

func NewNode(
	commonNode *committee.Node,
	commonCfg commonWorker.Config,
	roleProvider registration.RoleProvider,
) (*Node, error)

NewNode initializes a new executor node.

func (*Node) Cleanup

func (n *Node) Cleanup()

Cleanup performs the service specific post-termination cleanup.

func (*Node) GetStatus

func (n *Node) GetStatus(ctx context.Context) (*api.Status, error)

GetStatus returns the executor committee node status.

func (*Node) HandleEpochTransitionLocked

func (n *Node) HandleEpochTransitionLocked(epoch *committee.EpochSnapshot)

HandleEpochTransitionLocked implements NodeHooks. Guarded by n.commonNode.CrossNode.

func (*Node) HandleNewBlockEarlyLocked

func (n *Node) HandleNewBlockEarlyLocked(blk *block.Block)

HandleNewBlockEarlyLocked implements NodeHooks. Guarded by n.commonNode.CrossNode.

func (*Node) HandleNewBlockLocked

func (n *Node) HandleNewBlockLocked(blk *block.Block)

HandleNewBlockLocked implements NodeHooks. Guarded by n.commonNode.CrossNode.

func (*Node) HandleNewEventLocked

func (n *Node) HandleNewEventLocked(ev *roothash.Event)

HandleNewEventLocked implements NodeHooks. Guarded by n.commonNode.CrossNode.

func (*Node) HandlePeerTx

func (n *Node) HandlePeerTx(ctx context.Context, tx []byte) error

HandlePeerTx implements NodeHooks.

func (*Node) HandleRuntimeHostEventLocked

func (n *Node) HandleRuntimeHostEventLocked(ev *host.Event)

func (*Node) Initialized

func (n *Node) Initialized() <-chan struct{}

Initialized returns a channel that will be closed when the node is initialized and ready to service requests.

func (*Node) Name

func (n *Node) Name() string

Name returns the service name.

func (*Node) Quit

func (n *Node) Quit() <-chan struct{}

Quit returns a channel that will be closed when the service terminates.

func (*Node) Start

func (n *Node) Start() error

Start starts the service.

func (*Node) Stop

func (n *Node) Stop()

Stop halts the service.

func (*Node) WatchStateTransitions

func (n *Node) WatchStateTransitions() (<-chan NodeState, *pubsub.Subscription)

WatchStateTransitions subscribes to the node's state transitions.

type NodeState

type NodeState interface {
	// Name returns the name of the state.
	Name() StateName
}

NodeState is a node's state.

type StateName

type StateName string

StateName is a symbolic state without the attached values.

type StateNotReady

type StateNotReady struct{}

StateNotReady is the not ready state.

func (StateNotReady) Name

func (s StateNotReady) Name() StateName

Name returns the name of the state.

func (StateNotReady) String

func (s StateNotReady) String() string

String returns a string representation of the state.

type StateProcessingBatch

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

StateProcessingBatch is the processing batch state.

func (StateProcessingBatch) Name

func (s StateProcessingBatch) Name() StateName

Name returns the name of the state.

func (StateProcessingBatch) String

func (s StateProcessingBatch) String() string

String returns a string representation of the state.

type StateWaitingForBatch

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

StateWaitingForBatch is the waiting for batch state.

func (StateWaitingForBatch) Name

func (s StateWaitingForBatch) Name() StateName

Name returns the name of the state.

func (StateWaitingForBatch) String

func (s StateWaitingForBatch) String() string

String returns a string representation of the state.

type StateWaitingForBlock

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

StateWaitingForBlock is the waiting for block state.

func (StateWaitingForBlock) Name

func (s StateWaitingForBlock) Name() StateName

Name returns the name of the state.

func (StateWaitingForBlock) String

func (s StateWaitingForBlock) String() string

String returns a string representation of the state.

type StateWaitingForEvent

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

StateWaitingForEvent is the waiting for event state.

func (StateWaitingForEvent) Name

func (s StateWaitingForEvent) Name() StateName

Name returns the name of the state.

func (StateWaitingForEvent) String

func (s StateWaitingForEvent) String() string

String returns a string representation of the state.

type StateWaitingForFinalize

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

StateWaitingForFinalize is the waiting for finalize state.

func (StateWaitingForFinalize) Name

func (s StateWaitingForFinalize) Name() StateName

Name returns the name of the state.

func (StateWaitingForFinalize) String

func (s StateWaitingForFinalize) String() string

String returns a string representation of the state.

type StateWaitingForTxs

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

func (StateWaitingForTxs) Name

func (s StateWaitingForTxs) Name() StateName

Name returns the name of the state.

func (StateWaitingForTxs) String

func (s StateWaitingForTxs) String() string

String returns a string representation of the state.