framestream

README

Frame Streams implementation in Go

https://github.com/farsightsec/golang-framestream

Frame Streams is a lightweight, binary-clean protocol that allows for the transport of arbitrarily encoded data payload sequences with minimal framing overhead.

This package provides a pure Golang implementation. The Frame Streams implementation in C is at https://github.com/farsightsec/fstrm/.

The example framestream_dump program reads a Frame Streams formatted input file and prints the data frames and frame byte counts.

Documentation

Index

• Constants
• Variables
• type ControlFrame
  • func (c *ControlFrame) Decode(r io.Reader) (err error)
  • func (c *ControlFrame) DecodeEscape(r io.Reader) error
  • func (c *ControlFrame) DecodeTypeEscape(r io.Reader, ctype uint32) error
  • func (c *ControlFrame) Encode(w io.Writer) (err error)
  • func (c *ControlFrame) EncodeFlush(w *bufio.Writer) error
  • func (c *ControlFrame) MatchContentType(ctype []byte) bool
  • func (c *ControlFrame) SetContentType(ctype []byte)
• type Decoder
  • func NewDecoder(r io.Reader, opt *DecoderOptions) (dec *Decoder, err error)
  • func (dec *Decoder) Decode() (frameData []byte, err error)
• type DecoderOptions
• type Encoder
  • func NewEncoder(w io.Writer, opt *EncoderOptions) (enc *Encoder, err error)
  • func (enc *Encoder) Close() (err error)
  • func (enc *Encoder) Flush() error
  • func (enc *Encoder) Write(frame []byte) (n int, err error)
• type EncoderOptions

Constants

const CONTROL_ACCEPT = 0x01

const CONTROL_FIELD_CONTENT_TYPE = 0x01

const CONTROL_FINISH = 0x05

const CONTROL_READY = 0x04

const CONTROL_START = 0x02

const CONTROL_STOP = 0x03

const DEFAULT_MAX_PAYLOAD_SIZE = 1048576

const MAX_CONTROL_FRAME_SIZE = 512

Variables

var ControlAccept = ControlFrame{ControlType: CONTROL_ACCEPT}

var ControlFinish = ControlFrame{ControlType: CONTROL_FINISH}

var ControlReady = ControlFrame{ControlType: CONTROL_READY}

var ControlStart = ControlFrame{ControlType: CONTROL_START}

var ControlStop = ControlFrame{ControlType: CONTROL_STOP}

var EOF = io.EOF

var ErrContentTypeMismatch = errors.New("content type mismatch")

var ErrDataFrameTooLarge = errors.New("data frame too large")

var ErrDecode = errors.New("decoding error")

var ErrShortRead = errors.New("short read")

var ErrType = errors.New("invalid type")

Types

type ControlFrame

type ControlFrame struct {
	ControlType  uint32
	ContentTypes [][]byte
}

func (*ControlFrame) Decode

func (c *ControlFrame) Decode(r io.Reader) (err error)

func (*ControlFrame) DecodeEscape

func (c *ControlFrame) DecodeEscape(r io.Reader) error

func (*ControlFrame) DecodeTypeEscape

func (c *ControlFrame) DecodeTypeEscape(r io.Reader, ctype uint32) error

func (*ControlFrame) Encode

func (c *ControlFrame) Encode(w io.Writer) (err error)

func (*ControlFrame) EncodeFlush

func (c *ControlFrame) EncodeFlush(w *bufio.Writer) error

func (*ControlFrame) MatchContentType

func (c *ControlFrame) MatchContentType(ctype []byte) bool

func (*ControlFrame) SetContentType

func (c *ControlFrame) SetContentType(ctype []byte)

type Decoder

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

func NewDecoder

func NewDecoder(r io.Reader, opt *DecoderOptions) (dec *Decoder, err error)

func (*Decoder) Decode

func (dec *Decoder) Decode() (frameData []byte, err error)

type DecoderOptions

type DecoderOptions struct {
	MaxPayloadSize uint32
	ContentType    []byte
	Bidirectional  bool
	Timeout        time.Duration
}

type Encoder

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

func NewEncoder

func NewEncoder(w io.Writer, opt *EncoderOptions) (enc *Encoder, err error)

func (*Encoder) Close

func (enc *Encoder) Close() (err error)

func (*Encoder) Flush

func (enc *Encoder) Flush() error

func (*Encoder) Write

func (enc *Encoder) Write(frame []byte) (n int, err error)

type EncoderOptions

type EncoderOptions struct {
	ContentType   []byte
	Bidirectional bool
	Timeout       time.Duration
}