relay

Documentation

Index

• func New() *block
• func ToPeer(node *noise.Node, msg Message, doLookUp, incrementSeqNum bool) error
• type Message
  • func NewMessage(from kad.ID, to kad.ID, code byte, data []byte) Message
  • func (msg *Message) ChangeSeqNum(newSeqNum byte)
  • func (msg Message) Read(reader payload.Reader) (noise.Message, error)
  • func (msg Message) Write() []byte

Functions

func New

func New() *block

New sets up and returns a new Relay block instance.

func ToPeer

func ToPeer(node *noise.Node, msg Message, doLookUp, incrementSeqNum bool) error

ToPeer relays a message to peer synchronously.

Types

type Message

type Message struct {
	From      kad.ID
	To        kad.ID
	Hash      [hashSize]byte // TODO: Hash should be a method, not a field, since nodes should independently compute the hashes to be safe.
	SeenPeers []byte
	// Code is a single byte that indicates the type of Data so that Data can be properly deserialized.
	Code byte
	Data []byte
	// SeqNum is an incrementing sequence number (which wraps around 255, since it is of type byte). Messages with identical Code and Data but different SeqNums will hash differently.
	SeqNum byte
}

Message is a message with typed payload (Code and Data) to be relayed from From to To.

func NewMessage

func NewMessage(from kad.ID, to kad.ID, code byte, data []byte) Message

NewMessage creates a new Message instance.

func (*Message) ChangeSeqNum

func (msg *Message) ChangeSeqNum(newSeqNum byte)

ChangeSeqNum changes the message sequence number and rehashes the message.

func (Message) Read

func (msg Message) Read(reader payload.Reader) (noise.Message, error)

func (Message) Write

func (msg Message) Write() []byte