node

Documentation

Overview

Package node contains node logic.

Index

• type CalculateNextEpoch
• type Mode
• type Node
  • func NewEphemeralNode(id state.PeerID, t transport.Transport, nextEpoch CalculateNextEpoch, ...) *Node
  • func NewNode(ms store.MessageStore, st transport.Transport, ss state.SyncState, ...) *Node
  • func NewPersistentNode(db *sql.DB, st transport.Transport, id state.PeerID, mode Mode, ...) (*Node, error)
  • func (n *Node) AddPeer(group state.GroupID, id state.PeerID) error
  • func (n *Node) AppendEphemeralMessage(groupID state.GroupID, data []byte) (state.MessageID, error)
  • func (n *Node) AppendMessage(groupID state.GroupID, data []byte) (state.MessageID, error)
  • func (n *Node) AppendMessageWithMetadata(groupID state.GroupID, data []byte, metadata *protobuf.Metadata) (state.MessageID, error)
  • func (n *Node) CurrentEpoch() int64
  • func (n *Node) IsPeerInGroup(g state.GroupID, p state.PeerID) (bool, error)
  • func (n *Node) RequestMessage(group state.GroupID, id state.MessageID) error
  • func (n *Node) Start(duration time.Duration)
  • func (n *Node) Stop()
  • func (n *Node) Subscribe() chan protobuf.Message
  • func (n *Node) Unsubscribe()
• type ResolutionMode

Types

type CalculateNextEpoch

type CalculateNextEpoch func(count uint64, epoch int64) int64

CalculateNextEpoch is a function used to calculate the next `SendEpoch` for a given message.

type Mode

type Mode int

Mode represents the synchronization mode.

const (
	InteractiveMode Mode = iota + 1
	BatchMode
)

type Node

type Node struct {
	ID state.PeerID
	// contains filtered or unexported fields
}

Node represents an MVDS node, it runs all the logic like sending and receiving protocol messages.

func NewEphemeralNode

func NewEphemeralNode(
	id state.PeerID,
	t transport.Transport,
	nextEpoch CalculateNextEpoch,
	currentEpoch int64,
	mode Mode,
	logger *zap.Logger,
) *Node

func NewNode

func NewNode(
	ms store.MessageStore,
	st transport.Transport,
	ss state.SyncState,
	nextEpoch CalculateNextEpoch,
	currentEpoch int64,
	id state.PeerID,
	mode Mode,
	pp peers.Persistence,
	md dependency.Tracker,
	resolution ResolutionMode,
	logger *zap.Logger,
) *Node

NewNode returns a new node.

func NewPersistentNode

func NewPersistentNode(
	db *sql.DB,
	st transport.Transport,
	id state.PeerID,
	mode Mode,
	resolution ResolutionMode,
	nextEpoch CalculateNextEpoch,
	logger *zap.Logger,
) (*Node, error)

func (*Node) AddPeer

func (n *Node) AddPeer(group state.GroupID, id state.PeerID) error

AddPeer adds a peer to a specific group making it a recipient of messages.

func (*Node) AppendEphemeralMessage

func (n *Node) AppendEphemeralMessage(groupID state.GroupID, data []byte) (state.MessageID, error)

AppendEphemeralMessage sends a message to a given group that has the `no_ack_required` flag set to `true`.

func (*Node) AppendMessage

func (n *Node) AppendMessage(groupID state.GroupID, data []byte) (state.MessageID, error)

AppendMessage sends a message to a given group.

func (*Node) AppendMessageWithMetadata

func (n *Node) AppendMessageWithMetadata(groupID state.GroupID, data []byte, metadata *protobuf.Metadata) (state.MessageID, error)

AppendMessageWithMetadata sends a message to a given group with metadata.

func (*Node) CurrentEpoch

func (n *Node) CurrentEpoch() int64

func (*Node) IsPeerInGroup

func (n *Node) IsPeerInGroup(g state.GroupID, p state.PeerID) (bool, error)

IsPeerInGroup checks whether a peer is in the specified group.

func (*Node) RequestMessage

func (n *Node) RequestMessage(group state.GroupID, id state.MessageID) error

RequestMessage adds a REQUEST record to the next payload for a given message ID.

func (*Node) Start

func (n *Node) Start(duration time.Duration)

Start listens for new messages received by the node and sends out those required every epoch.

func (*Node) Stop

func (n *Node) Stop()

Stop message reading and epoch processing

func (*Node) Subscribe

func (n *Node) Subscribe() chan protobuf.Message

Subscribe subscribes to incoming messages.

func (*Node) Unsubscribe

func (n *Node) Unsubscribe()

Unsubscribe closes the listening channels

type ResolutionMode

type ResolutionMode int

ResolutionMode defines how message dependencies should be resolved.

const (
	// EventualMode is non-blocking and will return messages before dependencies are resolved.
	EventualMode ResolutionMode = iota + 1
	// ConsistentMode blocks and does not return messages until dependencies have been resolved.
	ConsistentMode
)