processing

Documentation

Index

• Constants
• func ReadFrame(r io.Reader) (uint64, error)
• func WriteFrame(buf *bytes.Buffer, magic protocol.Magic, cs []byte) error
• type Gossip
  • func NewGossip(magic protocol.Magic) *Gossip
  • func (g *Gossip) Process(m *bytes.Buffer) error
  • func (g *Gossip) UnpackLength(r io.Reader) (uint64, error)
• type Ponger
  • func NewPonger(responseChan chan<- *bytes.Buffer) Ponger
  • func (p *Ponger) Pong()

Constants

const (
	// MaxFrameSize is set at 250000 bytes
	MaxFrameSize = uint64(250000)
)

Functions

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 WriteFrame

func WriteFrame(buf *bytes.Buffer, magic protocol.Magic, 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 {
	Magic protocol.Magic
}

Gossip is a preprocessor for gossip messages.

func NewGossip

func NewGossip(magic protocol.Magic) *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) 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 Ponger

type Ponger struct {
	// contains filtered or unexported fields
}

Ponger responds to a Ping on a channel

func NewPonger

func NewPonger(responseChan chan<- *bytes.Buffer) Ponger

NewPonger instantiates a new Ponger with a new channel

func (*Ponger) Pong

func (p *Ponger) Pong()

Pong pushes a pong buffer to a channel