framing

Documentation

Index

• Constants
• func ReadFrameLength(buf []byte) (int, []byte)
• type Frame
• type PayloadFrame
  • func NewPayloadFrame(data []byte) *PayloadFrame
  • func (p *PayloadFrame) Bytes() []byte

Constants

const FrameLengthFieldSize = 3

Functions

func ReadFrameLength

func ReadFrameLength(buf []byte) (int, []byte)

ReadFrameLength reads frame length from bytes and returns the clean buf.

Types

type Frame

type Frame interface {
	// Bytes converts the frame to bytes
	Bytes() []byte
}

Frame represents a YoMo frame.

+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                    Frame Length               |
+-----------------------------------------------+
|                     Frame                     |
|                                               |
+-----------------------------------------------+

type PayloadFrame

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

PayloadFrame represents a payload frame.

func NewPayloadFrame

func NewPayloadFrame(data []byte) *PayloadFrame

NewPayloadFrame inits a new PayloadFrame.

func (*PayloadFrame) Bytes

func (p *PayloadFrame) Bytes() []byte

Bytes get the bytes of PayloadFrame.