example

Documentation

Index

• Constants
• func NewCodec() api.Protocol
• type MessageAckCommand
• type MessageCommand
• type Request
  • func (r *Request) GetData() api.IoBuffer
  • func (r *Request) GetHeader() api.HeaderMap
  • func (r *Request) GetRequestId() uint64
  • func (r *Request) GetStreamType() api.StreamType
  • func (r *Request) GetTimeout() int32
  • func (r *Request) IsGoAwayFrame() bool
  • func (r *Request) IsHeartbeatFrame() bool
  • func (r *Request) SetData(data api.IoBuffer)
  • func (r *Request) SetRequestId(id uint64)
• type Response
  • func (r *Response) GetHeader() api.HeaderMap
  • func (r *Response) GetRequestId() uint64
  • func (r *Response) GetStatusCode() uint32
  • func (r *Response) GetStreamType() api.StreamType
  • func (r *Response) SetRequestId(id uint64)
• type XCodec
  • func (codec *XCodec) HTTPMapping() api.HTTPMapping
  • func (codec *XCodec) NewXProtocol(_ context.Context) api.XProtocol
  • func (codec *XCodec) ProtocolMatch() api.ProtocolMatch
  • func (codec *XCodec) ProtocolName() api.ProtocolName

Constants

const (
	ProtocolName types.ProtocolName = "x_example" // protocol

	Magic       byte = 'x' //magic
	DirRequest  byte = 0   // dir
	DirResponse byte = 1   // dir

	TypeHeartbeat byte = 0 // cmd code
	TypeMessage   byte = 1
	TypeGoAway    byte = 2

	ResponseStatusSuccess uint16 = 0 // 0x00 response status
	ResponseStatusError   uint16 = 1 // 0x01

	RequestHeaderLen  int = 11 // protocol header fields length
	ResponseHeaderLen int = 13
	MinimalDecodeLen  int = RequestHeaderLen // minimal length for decoding

	RequestIdIndex = 3
)

protocol constants

Functions

func NewCodec

func NewCodec() api.Protocol

Types

type MessageAckCommand

type MessageAckCommand struct {
	Response

	// TODO: pb deserialize target, extract from Payload
	Message interface{}
}

type MessageCommand

type MessageCommand struct {
	Request

	// TODO: pb deserialize target, extract from Payload
	Message interface{}
}

type Request

type Request struct {
	Type       byte
	RequestId  uint32
	PayloadLen uint32
	Payload    []byte
	Content    types.IoBuffer
	header.CommonHeader
}

func (*Request) GetData

func (r *Request) GetData() api.IoBuffer

func (*Request) GetHeader

func (r *Request) GetHeader() api.HeaderMap

func (*Request) GetRequestId

func (r *Request) GetRequestId() uint64

func (*Request) GetStreamType

func (r *Request) GetStreamType() api.StreamType

func (*Request) GetTimeout

func (r *Request) GetTimeout() int32

func (*Request) IsGoAwayFrame

func (r *Request) IsGoAwayFrame() bool

func (*Request) IsHeartbeatFrame

func (r *Request) IsHeartbeatFrame() bool

func (*Request) SetData

func (r *Request) SetData(data api.IoBuffer)

func (*Request) SetRequestId

func (r *Request) SetRequestId(id uint64)

type Response

type Response struct {
	Request
	Status uint16
}

func (*Response) GetHeader

func (r *Response) GetHeader() api.HeaderMap

func (*Response) GetRequestId

func (r *Response) GetRequestId() uint64

func (*Response) GetStatusCode

func (r *Response) GetStatusCode() uint32

func (*Response) GetStreamType

func (r *Response) GetStreamType() api.StreamType

func (*Response) SetRequestId

func (r *Response) SetRequestId(id uint64)

type XCodec

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

func (*XCodec) HTTPMapping

func (codec *XCodec) HTTPMapping() api.HTTPMapping

func (*XCodec) NewXProtocol

func (codec *XCodec) NewXProtocol(_ context.Context) api.XProtocol

func (*XCodec) ProtocolMatch

func (codec *XCodec) ProtocolMatch() api.ProtocolMatch

func (*XCodec) ProtocolName

func (codec *XCodec) ProtocolName() api.ProtocolName