Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

framestream

package module

Go to main page

Versions in this module

v0

v0.3.0

Sep 8, 2020

Changes in this version

+ const CONTROL_FRAME_LENGTH_MAX

type ControlFrame

+ func (c *ControlFrame) ChooseContentType(ctypes [][]byte) (typ []byte, found bool)

+ func (c *ControlFrame) SetContentTypes(ctypes [][]byte)

+ type Reader struct

+ func NewReader(r io.Reader, opt *ReaderOptions) (*Reader, error)

+ func (r *Reader) ContentType() []byte

+ func (r *Reader) ReadFrame(b []byte) (length int, err error)

+ type ReaderOptions struct

+ Bidirectional bool

+ ContentTypes [][]byte

+ Timeout time.Duration

+ type Writer struct

+ func NewWriter(w io.Writer, opt *WriterOptions) (writer *Writer, err error)

+ func (w *Writer) Close() (err error)

+ func (w *Writer) ContentType() []byte

+ func (w *Writer) Flush() error

+ func (w *Writer) WriteFrame(frame []byte) (n int, err error)

+ type WriterOptions struct

+ Bidirectional bool

+ ContentTypes [][]byte

+ Timeout time.Duration

v0.2.0

Apr 25, 2019

Changes in this version

+ const CONTROL_ACCEPT

+ const CONTROL_FIELD_CONTENT_TYPE

+ const CONTROL_FINISH

+ const CONTROL_READY

+ const CONTROL_START

+ const CONTROL_STOP

+ const DEFAULT_MAX_PAYLOAD_SIZE

+ const MAX_CONTROL_FRAME_SIZE

+ var ControlAccept = ControlFrame

+ var ControlFinish = ControlFrame

+ var ControlReady = ControlFrame

+ var ControlStart = ControlFrame

+ var ControlStop = ControlFrame

+ 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")

+ type ControlFrame struct

+ ContentTypes [][]byte

+ ControlType uint32

+ 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 struct

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

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

+ type DecoderOptions struct

+ Bidirectional bool

+ ContentType []byte

+ MaxPayloadSize uint32

+ Timeout time.Duration

+ type Encoder struct

+ 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 struct

+ Bidirectional bool

+ ContentType []byte

+ Timeout time.Duration