framing

May 23, 2020

Changes in this version

type BaseFrame

+ func (p *BaseFrame) CanResume() bool

type Frame

+ CanResume func() bool

Nov 7, 2019

Changes in this version

type FrameLease

+ func NewFrameLease(ttl time.Duration, n uint32, metadata []byte) *FrameLease

Aug 5, 2019

Changes in this version

type BaseFrame

+ func (p *BaseFrame) Done()

+ func (p *BaseFrame) DoneNotify() <-chan struct{}

type Frame

+ Done func()

+ DoneNotify func() <-chan struct{}

type FrameError

+ func (p *FrameError) String() string

Jul 28, 2019

Changes in this version

type BaseFrame

+ func (p *BaseFrame) ReleaseNotify() <-chan struct{}

Jun 9, 2019

Changes in this version

+ const FlagComplete

+ const FlagFollow

+ const FlagIgnore

+ const FlagLease

+ const FlagMetadata

+ const FlagNext

+ const FlagRespond

+ const FlagResume

+ const HeaderLen

+ func CalcPayloadFrameSize(data, metadata []byte) int

+ type BaseFrame struct

+ func NewBaseFrame(h FrameHeader, body *common.ByteBuff) *BaseFrame

+ func (p *BaseFrame) Body() *common.ByteBuff

+ func (p *BaseFrame) Bytes() []byte

+ func (p *BaseFrame) Header() FrameHeader

+ func (p *BaseFrame) IsResumable() bool

+ func (p *BaseFrame) Len() int

+ func (p *BaseFrame) Release()

+ func (p *BaseFrame) SetBody(body *common.ByteBuff)

+ func (p *BaseFrame) SetHeader(h FrameHeader)

+ func (p *BaseFrame) WriteTo(w io.Writer) (n int64, err error)

+ type Frame interface

+ Body func() *common.ByteBuff

+ Bytes func() []byte

+ Header func() FrameHeader

+ IsResumable func() bool

+ Len func() int

+ Release func()

+ SetBody func(body *common.ByteBuff)

+ SetHeader func(h FrameHeader)

+ Validate func() error

+ func NewFromBase(f *BaseFrame) (frame Frame, err error)

+ type FrameCancel struct

+ func NewFrameCancel(sid uint32) *FrameCancel

+ func (p *FrameCancel) String() string

+ func (p *FrameCancel) Validate() (err error)

+ type FrameError struct

+ func NewFrameError(streamID uint32, code common.ErrorCode, data []byte) *FrameError

+ func (p *FrameError) Error() string

+ func (p *FrameError) ErrorCode() common.ErrorCode

+ func (p *FrameError) ErrorData() []byte

+ func (p *FrameError) Validate() (err error)

+ type FrameFNF struct

+ func NewFrameFNF(sid uint32, data, metadata []byte, flags ...FrameFlag) *FrameFNF

+ func (p *FrameFNF) Data() []byte

+ func (p *FrameFNF) DataUTF8() string

+ func (p *FrameFNF) Metadata() ([]byte, bool)

+ func (p *FrameFNF) MetadataUTF8() (metadata string, ok bool)

+ func (p *FrameFNF) String() string

+ func (p *FrameFNF) Validate() (err error)

+ type FrameFlag uint16

+ func (f FrameFlag) Check(mask FrameFlag) bool

+ func (f FrameFlag) String() string

+ type FrameHeader [HeaderLen]byte

+ func NewFrameHeader(streamID uint32, frameType FrameType, flags ...FrameFlag) FrameHeader

+ func ParseFrameHeader(bs []byte) FrameHeader

+ func (p FrameHeader) Flag() FrameFlag

+ func (p FrameHeader) StreamID() uint32

+ func (p FrameHeader) String() string

+ func (p FrameHeader) Type() FrameType

+ func (p FrameHeader) WriteTo(w io.Writer) (int64, error)

+ type FrameKeepalive struct

+ func NewFrameKeepalive(position uint64, data []byte, respond bool) *FrameKeepalive

+ func (p *FrameKeepalive) Data() []byte

+ func (p *FrameKeepalive) LastReceivedPosition() uint64

+ func (p *FrameKeepalive) String() string

+ func (p *FrameKeepalive) Validate() (err error)

+ type FrameLease struct

+ func (p *FrameLease) Metadata() []byte

+ func (p *FrameLease) NumberOfRequests() uint32

+ func (p *FrameLease) String() string

+ func (p *FrameLease) TimeToLive() time.Duration

+ func (p *FrameLease) Validate() (err error)

+ type FrameMetadataPush struct

+ func NewFrameMetadataPush(metadata []byte) *FrameMetadataPush

+ func (p *FrameMetadataPush) Data() []byte

+ func (p *FrameMetadataPush) DataUTF8() (data string)

+ func (p *FrameMetadataPush) Metadata() ([]byte, bool)

+ func (p *FrameMetadataPush) MetadataUTF8() (metadata string, ok bool)

+ func (p *FrameMetadataPush) String() string

+ func (p *FrameMetadataPush) Validate() (err error)

+ type FramePayload struct

+ func NewFramePayload(id uint32, data, metadata []byte, flags ...FrameFlag) *FramePayload

+ func (p *FramePayload) Data() []byte

+ func (p *FramePayload) DataUTF8() string

+ func (p *FramePayload) Metadata() ([]byte, bool)

+ func (p *FramePayload) MetadataUTF8() (metadata string, ok bool)

+ func (p *FramePayload) String() string

+ func (p *FramePayload) Validate() (err error)

+ type FrameRequestChannel struct

+ func NewFrameRequestChannel(sid uint32, n uint32, data, metadata []byte, flags ...FrameFlag) *FrameRequestChannel

+ func (p *FrameRequestChannel) Data() []byte

+ func (p *FrameRequestChannel) DataUTF8() string

+ func (p *FrameRequestChannel) InitialRequestN() uint32

+ func (p *FrameRequestChannel) Metadata() ([]byte, bool)

+ func (p *FrameRequestChannel) MetadataUTF8() (metadata string, ok bool)

+ func (p *FrameRequestChannel) String() string

+ func (p *FrameRequestChannel) Validate() (err error)

+ type FrameRequestN struct

+ func NewFrameRequestN(sid, n uint32, flags ...FrameFlag) *FrameRequestN

+ func (p *FrameRequestN) N() uint32

+ func (p *FrameRequestN) String() string

+ func (p *FrameRequestN) Validate() (err error)

+ type FrameRequestResponse struct

+ func NewFrameRequestResponse(id uint32, data, metadata []byte, flags ...FrameFlag) *FrameRequestResponse

+ func (p *FrameRequestResponse) Data() []byte

+ func (p *FrameRequestResponse) DataUTF8() string

+ func (p *FrameRequestResponse) Metadata() ([]byte, bool)

+ func (p *FrameRequestResponse) MetadataUTF8() (metadata string, ok bool)

+ func (p *FrameRequestResponse) String() string

+ func (p *FrameRequestResponse) Validate() (err error)

+ type FrameRequestStream struct

+ func NewFrameRequestStream(id uint32, n uint32, data, metadata []byte, flags ...FrameFlag) *FrameRequestStream

+ func (p *FrameRequestStream) Data() []byte

+ func (p *FrameRequestStream) DataUTF8() string

+ func (p *FrameRequestStream) InitialRequestN() uint32

+ func (p *FrameRequestStream) Metadata() ([]byte, bool)

+ func (p *FrameRequestStream) MetadataUTF8() (metadata string, ok bool)

+ func (p *FrameRequestStream) String() string

+ func (p *FrameRequestStream) Validate() (err error)

+ type FrameResume struct

+ func NewFrameResume(version common.Version, token []byte, ...) *FrameResume

+ func (p *FrameResume) FirstAvailableClientPosition() uint64

+ func (p *FrameResume) LastReceivedServerPosition() uint64

+ func (p *FrameResume) String() string

+ func (p *FrameResume) Token() []byte

+ func (p *FrameResume) Validate() (err error)

+ func (p *FrameResume) Version() common.Version

+ type FrameResumeOK struct

+ func NewResumeOK(position uint64) *FrameResumeOK

+ func (p *FrameResumeOK) LastReceivedClientPosition() uint64

+ func (p *FrameResumeOK) String() string

+ func (p *FrameResumeOK) Validate() (err error)

+ type FrameSetup struct

+ func NewFrameSetup(version common.Version, timeBetweenKeepalive, maxLifetime time.Duration, ...) *FrameSetup

+ func (p *FrameSetup) Data() []byte

+ func (p *FrameSetup) DataMimeType() (mime string)

+ func (p *FrameSetup) DataUTF8() string

+ func (p *FrameSetup) MaxLifetime() time.Duration

+ func (p *FrameSetup) Metadata() ([]byte, bool)

+ func (p *FrameSetup) MetadataMimeType() string

+ func (p *FrameSetup) MetadataUTF8() (metadata string, ok bool)

+ func (p *FrameSetup) String() string

+ func (p *FrameSetup) TimeBetweenKeepalive() time.Duration

+ func (p *FrameSetup) Token() []byte

+ func (p *FrameSetup) Validate() (err error)

+ func (p *FrameSetup) Version() common.Version

+ type FrameType uint8

+ const FrameTypeCancel

+ const FrameTypeError

+ const FrameTypeExt

+ const FrameTypeKeepalive

+ const FrameTypeLease

+ const FrameTypeMetadataPush

+ const FrameTypePayload

+ const FrameTypeRequestChannel

+ const FrameTypeRequestFNF

+ const FrameTypeRequestN

+ const FrameTypeRequestResponse

+ const FrameTypeRequestStream

+ const FrameTypeReserved

+ const FrameTypeResume

+ const FrameTypeResumeOK

+ const FrameTypeSetup

+ func (f FrameType) String() string