protocol

Documentation

Overview

nolint

Index

• Constants
• Variables
• func ExtractVersion(r io.Reader) (*semver.Version, error)
• func ReadFrame(r io.Reader) (uint64, error)
• func VersionAsBuffer() bytes.Buffer
• func WriteFrame(buf *bytes.Buffer, cs []byte) error
• type Gossip
  • func NewGossip() *Gossip
  • func (g *Gossip) Process(m *bytes.Buffer) error
  • func (g *Gossip) ReadFrame(src io.Reader) ([]byte, error)
  • func (g *Gossip) ReadMessage(src io.Reader) ([]byte, error)
  • func (g *Gossip) UnpackLength(r io.Reader) (uint64, error)
• type ServiceFlag
• type Version
  • func (v *Version) Decode(r *bytes.Buffer) error
  • func (v *Version) Encode(w *bytes.Buffer) error
  • func (v Version) String() string

Constants

const (
	// MaxFrameSize is set at 1375000 bytes.
	MaxFrameSize = uint64(1375000)

	// VersionLength is number of bytes the version uses.
	VersionLength = uint64(8)
)

const VersionConstraintString = "~0.1.0"

VersionConstraintString represent the needed version.

Variables

var CurrentProtocolVersion = semver.MustParse("0.1.0")

CurrentProtocolVersion indicates the protocol version used.

var NodeVer = &Version{
	Major: 0,
	Minor: 4,
	Patch: 3,
}

NodeVer is the current node version. This is used only in the handshake, need to be removed.

var VersionConstraint, _ = semver.NewConstraint(VersionConstraintString)

VersionConstraint check incoming versions.

Functions

func ExtractVersion

func ExtractVersion(r io.Reader) (*semver.Version, error)

ExtractVersion extracts the version from io.Reader.

func ReadFrame

func ReadFrame(r io.Reader) (uint64, error)

ReadFrame extract the bytes representing the size of the packet and thus read the amount of bytes specified by such prefix in little endianness.

func VersionAsBuffer

func VersionAsBuffer() bytes.Buffer

VersionAsBuffer returns protocol version encoded as BytesBuffer.

func WriteFrame

func WriteFrame(buf *bytes.Buffer, cs []byte) error

WriteFrame mutates a buffer by adding a length-prefixing wire message frame at the beginning of the message.

Types

type Gossip

type Gossip struct {
}

Gossip is a preprocessor/reader for gossip messages.

func NewGossip

func NewGossip() *Gossip

NewGossip returns a gossip preprocessor with the specified magic.

func (*Gossip) Process

func (g *Gossip) Process(m *bytes.Buffer) error

Process a message that is passing through, by prepending magic and the message checksum, and finally by prepending the length.

func (*Gossip) ReadFrame

func (g *Gossip) ReadFrame(src io.Reader) ([]byte, error)

ReadFrame extract message from gossip frame, if no errors found.

func (*Gossip) ReadMessage

func (g *Gossip) ReadMessage(src io.Reader) ([]byte, error)

ReadMessage reads from the connection. TODO: Replace ReadMessage with ReadFrame.

func (*Gossip) UnpackLength

func (g *Gossip) UnpackLength(r io.Reader) (uint64, error)

UnpackLength unwraps the incoming packet (likely from a net.Conn struct) and returns the length of the packet without reading the payload (which is left to the user of this method).

type ServiceFlag

type ServiceFlag uint64

ServiceFlag indicates the services provided by the Node.

const (
	// FullNode indicates that a user is running the full node implementation of Dusk.
	FullNode ServiceFlag = 1

	// VoucherNode indicates that a user is running a voucher seeder.
	VoucherNode ServiceFlag = 3
)

type Version

type Version struct {
	Major uint8
	Minor uint8
	Patch uint16
}

Version is a struct that separates version fields.

func (*Version) Decode

func (v *Version) Decode(r *bytes.Buffer) error

Decode will Decodde a Version struct from r.

func (*Version) Encode

func (v *Version) Encode(w *bytes.Buffer) error

Encode will encode a Version struct to w.

func (Version) String

func (v Version) String() string