broadcast

package

v1.1.1-0...-7cefdf7 Latest Latest Go to latest Published: Mar 18, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/guyu96/noise

Documentation ¶

Index ¶

func New() *block
func Send(node *noise.Node, from kad.ID, code byte, data []byte, minBucketID int, ...)
type Message
- func NewMessage(from kad.ID, prefixlen uint16, code byte, data []byte) Message

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New() *block

New sets up and returns a new Broadcast block instance.

func Send ¶

func Send(node *noise.Node, from kad.ID, code byte, data []byte, minBucketID int, maxBucketID int, seqNum byte, incrementSeqNum bool)

Send starts broadcasting data to the network.

Types ¶

type Message ¶

type Message struct {
	From      kad.ID
	PrefixLen uint16
	Hash      [hashSize]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 broadcasted. Unlike relay messages, broadcast messages do not have SeenPeers because the number of seen peers could be much larger.

func NewMessage ¶

func NewMessage(from kad.ID, prefixlen uint16, 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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL