tars

Documentation

Index

• Constants
• Variables
• type Request
  • func NewRpcRequest(headers types.HeaderMap, data types.IoBuffer) *Request
  • func (r *Request) GetData() types.IoBuffer
  • func (r *Request) GetHeader() types.HeaderMap
  • func (r *Request) GetRequestId() uint64
  • func (r *Request) GetStreamType() api.StreamType
  • func (r *Request) GetTimeout() int32
  • func (r *Request) IsHeartbeatFrame() bool
  • func (r *Request) SetData(data types.IoBuffer)
  • func (r *Request) SetRequestId(id uint64)
• type Response
  • func NewRpcResponse(headers types.HeaderMap, data types.IoBuffer) *Response
  • func (r *Response) GetData() types.IoBuffer
  • func (r *Response) GetHeader() types.HeaderMap
  • func (r *Response) GetRequestId() uint64
  • func (r *Response) GetStatusCode() uint32
  • func (r *Response) GetStreamType() api.StreamType
  • func (r *Response) GetTimeout() int32
  • func (r *Response) IsHeartbeatFrame() bool
  • func (r *Response) SetData(data types.IoBuffer)
  • 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 (
	MessageSizeLen    int = 4
	IVersionLen       int = 2
	IVersionHeaderIdx int = 4
)

const (
	CmdTypeResponse byte   = 0 // cmd type
	CmdTypeRequest  byte   = 1
	CmdTypeUndefine byte   = 2
	UnKnownCmdType  string = "unknown cmd type"
)

const (
	ServiceNameHeader string = "service"
	MethodNameHeader  string = "method"
)

const (
	ProtocolName = "tars"
)

const (
	ResponseStatusSuccess uint16 = 0x00 // 0x00 response status
)

Variables

var MagicTag = []byte{0xda, 0xbb}

Types

type Request

type Request struct {
	protocol.CommonHeader
	// contains filtered or unexported fields
}

func NewRpcRequest

func NewRpcRequest(headers types.HeaderMap, data types.IoBuffer) *Request

NewRpcRequest is a utility function which build rpc Request object of bolt protocol.

func (*Request) GetData

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

func (*Request) GetHeader

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

func (*Request) GetRequestId

func (r *Request) GetRequestId() uint64

~ XFrame

func (*Request) GetStreamType

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

func (*Request) GetTimeout

func (r *Request) GetTimeout() int32

TODO: add timeout

func (*Request) IsHeartbeatFrame

func (r *Request) IsHeartbeatFrame() bool

func (*Request) SetData

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

func (*Request) SetRequestId

func (r *Request) SetRequestId(id uint64)

type Response

type Response struct {
	protocol.CommonHeader
	// contains filtered or unexported fields
}

func NewRpcResponse

func NewRpcResponse(headers types.HeaderMap, data types.IoBuffer) *Response

NewRpcResponse is a utility function which build rpc Response object of bolt protocol.

func (*Response) GetData

func (r *Response) GetData() types.IoBuffer

func (*Response) GetHeader

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

func (*Response) GetRequestId

func (r *Response) GetRequestId() uint64

~ XFrame

func (*Response) GetStatusCode

func (r *Response) GetStatusCode() uint32

func (*Response) GetStreamType

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

func (*Response) GetTimeout

func (r *Response) GetTimeout() int32

response contains no timeout

func (*Response) IsHeartbeatFrame

func (r *Response) IsHeartbeatFrame() bool

func (*Response) SetData

func (r *Response) SetData(data types.IoBuffer)

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