frame

type BasicTransport ¶

type BasicTransport struct {
	io.ReadWriteCloser
	Header
	RStreamSyn
	RStreamRst
	RStreamData
	RStreamWndInc
	RGoAway
}

BasicTransport can serialize/deserialize frames on an underlying net.Conn to implement the muxado protocol.

func NewBasicTransport(rwc io.ReadWriteCloser) *BasicTransport

func (t *BasicTransport) ReadFrame() (f RFrame, err error)

func (t *BasicTransport) WriteFrame(frame WFrame) (err error)

type DebugTransport ¶

type DebugTransport struct {
	*BasicTransport
	// contains filtered or unexported fields
}

func NewDebugTransport(rwc io.ReadWriteCloser, prefix string) *DebugTransport

func (t *DebugTransport) ReadFrame() (f RFrame, err error)

func (t *DebugTransport) Write(buf []byte) (int, error)

func (t *DebugTransport) WriteFrame(frame WFrame) (err error)

type ErrorCode ¶

type ErrorCode uint32

ErrorCode is a 32-bit integer indicating a error condition included in rst/goaway frames

type FrameType ¶

type FrameType uint8

a frameType is a 5-bit integer in the frame header that identifies the type of frame

type FramingError ¶

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

type Header ¶

type Header []byte

func (b Header) Fin() bool

func (b Header) Flags() flagsType

func (b Header) Length() uint16

func (b Header) SetAll(ftype FrameType, length int, streamId StreamId, flags flagsType) (err error)

func (b Header) SetFlags(fl flagsType) (err error)

func (b Header) SetLength(length int) (err error)

func (b Header) SetStreamId(streamId StreamId) (err error)

func (b Header) SetType(t FrameType) (err error)

func (b Header) StreamId() StreamId

func (b Header) Type() FrameType

type RFrame ¶

type RFrame interface {
	StreamId() StreamId
	Type() FrameType
	// contains filtered or unexported methods
}

A frame can read and write itself to a serializer/deserializer

type RGoAway ¶

type RGoAway struct {
	Header
	// contains filtered or unexported fields
}

Instruct the remote side not to initiate new streams

func (f *RGoAway) Debug() []byte

func (f *RGoAway) ErrorCode() ErrorCode

func (f *RGoAway) LastStreamId() StreamId

type RStreamData ¶

type RStreamData struct {
	Header
	// contains filtered or unexported fields
}

func (f *RStreamData) Reader() io.Reader

type RStreamRst ¶

type RStreamRst struct {
	Header
	// contains filtered or unexported fields
}

RsStreamRst is a STREAM_RST frame that is read from a transport

func (f *RStreamRst) ErrorCode() ErrorCode

type RStreamSyn ¶

type RStreamSyn struct {
	Header
	// contains filtered or unexported fields
}

func (f *RStreamSyn) StreamPriority() StreamPriority

func (f *RStreamSyn) StreamType() StreamType

type RStreamWndInc ¶

type RStreamWndInc struct {
	Header
	// contains filtered or unexported fields
}

Increase a stream's flow control window size

func (f *RStreamWndInc) WindowIncrement() (inc uint32)

type StreamId ¶

type StreamId uint32

StreamId is 31-bit integer uniquely identifying a stream within a session

type StreamPriority ¶

type StreamPriority uint32

StreamPriority is 31-bit integer specifying a stream's priority

type StreamType ¶

type StreamType uint32

StreamType is 32-bit integer specifying a stream's type

type Transport ¶

type Transport interface {
	WriteFrame(WFrame) error
	ReadFrame() (RFrame, error)
	Close() error
}

type WFrame ¶

type WFrame interface {
	// contains filtered or unexported methods
}

type WGoAway ¶

type WGoAway struct {
	Header
	// contains filtered or unexported fields
}

func NewWGoAway() (f *WGoAway)

func (f *WGoAway) Set(lastStreamId StreamId, errorCode ErrorCode, debug []byte) (err error)

type WStreamData ¶

type WStreamData struct {
	Header
	// contains filtered or unexported fields
}

WStreamData is a StreamData frame that you can write It delivers opaque data on a stream to the application layer

func NewWStreamData() (f *WStreamData)

func (f *WStreamData) Set(streamId StreamId, data []byte, fin bool) (err error)

type WStreamRst ¶

type WStreamRst struct {
	Header
	// contains filtered or unexported fields
}

WStreamRst is a STREAM_RST frame that can be written, it terminate a stream ungracefully

func NewWStreamRst() (f *WStreamRst)

func (f *WStreamRst) Set(streamId StreamId, errorCode ErrorCode) (err error)

type WStreamSyn ¶

type WStreamSyn struct {
	Header
	// contains filtered or unexported fields
}

func NewWStreamSyn() (f *WStreamSyn)

func (f *WStreamSyn) Set(streamId StreamId, streamPriority StreamPriority, streamType StreamType, fin bool) (err error)

type WStreamWndInc ¶

type WStreamWndInc struct {
	Header
	// contains filtered or unexported fields
}

func NewWStreamWndInc() (f *WStreamWndInc)

func (f *WStreamWndInc) Set(streamId StreamId, inc uint32) (err error)