chopper

Documentation

Overview

Package chopper helps splitting messages into smaller pieces and reassemble them

Index

• Constants
• func NumChunks(dataLen, maxMsgSize, includingChoppingOverhead int) (uint16, int, error)
• type Chopper
  • func NewChopper() *Chopper
  • func (c *Chopper) ChopData(data []byte, maxMsgSize, includingChoppingOverhead int) ([][]byte, bool, error)
  • func (c *Chopper) Close()
  • func (c *Chopper) IncomingChunk(data []byte, maxMsgSize, includingChoppingOverhead int) ([]byte, error)

Constants

const (

	// MaxNChunks maximum number of chunks
	MaxNChunks = math.MaxUint16
)

Functions

func NumChunks

func NumChunks(dataLen, maxMsgSize, includingChoppingOverhead int) (uint16, int, error)

NumChunks returns the expected amount of chunks for the given data length

Types

type Chopper

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

Chopper handles the splitting and joining of large messages

func NewChopper

func NewChopper() *Chopper

NewChopper creates a new chopper instance

func (*Chopper) ChopData

func (c *Chopper) ChopData(data []byte, maxMsgSize, includingChoppingOverhead int) ([][]byte, bool, error)

ChopData chops data into pieces (not more than 255) and adds chopper header to each piece for IncomingChunk function to reassemble it

func (*Chopper) Close

func (c *Chopper) Close()

Close stops the internal cleanup goroutine

func (*Chopper) IncomingChunk

func (c *Chopper) IncomingChunk(data []byte, maxMsgSize, includingChoppingOverhead int) ([]byte, error)

IncomingChunk collects all incoming chunks. Returned != nil value of the reassembled data maxChunkSize parameter must be the same on both sides