fragmentation

Documentation

Index

• Constants
• func IsValidFragment(fragment int) (err error)
• func Split(mtu int, data []byte, metadata []byte, onFrame HandleSplitResult)
• func SplitSkip(mtu int, skip int, data []byte, metadata []byte, onFrame HandleSplitResult)
• type HandleSplitResult
• type HeaderAndPayload
• type Joiner
  • func NewJoiner(first HeaderAndPayload) Joiner
• type SplitResult

Constants

const (
	// MinFragment is minimum fragment size in bytes.
	MinFragment = core.FrameHeaderLen + 4
	// MaxFragment is minimum fragment size in bytes.
	MaxFragment = common.MaxUint24 - 3
)

Functions

func IsValidFragment

func IsValidFragment(fragment int) (err error)

IsValidFragment validate fragment size.

func Split

func Split(mtu int, data []byte, metadata []byte, onFrame HandleSplitResult)

Split split data and metadata in frame.

func SplitSkip

func SplitSkip(mtu int, skip int, data []byte, metadata []byte, onFrame HandleSplitResult)

SplitSkip skip some bytes and split data and metadata in frame.

Types

type HandleSplitResult

type HandleSplitResult = func(index int, result SplitResult)

HandleSplitResult is callback for fragmentation result.

type HeaderAndPayload

type HeaderAndPayload interface {
	payload.Payload
	// FrameHeader returns a header of frame.
	Header() core.FrameHeader
}

HeaderAndPayload is Payload which having a FrameHeader.

type Joiner

type Joiner interface {
	HeaderAndPayload
	// First returns the first frame.
	First() core.Frame
	// Push append a new frame and returns true if joiner is end.
	Push(elem HeaderAndPayload) (end bool)
}

Joiner is used to join frames to a payload.

func NewJoiner

func NewJoiner(first HeaderAndPayload) Joiner

NewJoiner returns a new joiner.

type SplitResult

type SplitResult struct {
	Flag     core.FrameFlag
	Metadata []byte
	Data     []byte
}

SplitResult defines fragmentation result struct.