node

Documentation

Overview

Package Node contains node logic.

Index

• type CalculateNextEpoch
• type Mode
• type Node
  • func NewNode(ms store.MessageStore, st transport.Transport, ss state.SyncState, ...) *Node
  • func (n *Node) AddPeer(group state.GroupID, id state.PeerID) error
  • func (n *Node) AppendMessage(groupID state.GroupID, data []byte) (state.MessageID, error)
  • 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()

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 (
	INTERACTIVE Mode = iota
	BATCH
)

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 NewNode

func NewNode(
	ms store.MessageStore,
	st transport.Transport,
	ss state.SyncState,
	nextEpoch CalculateNextEpoch,
	currentEpoch int64,
	id state.PeerID,
	mode Mode,
	pp peers.Persistence,
) *Node

NewNode returns a new node.

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) AppendMessage

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

AppendMessage sends a message to a given group.

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