api

package
v1.6.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 19, 2024 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StreamTypeRaw         = 0
	StreamTypeAsyncCall   = 1
	StreamTypeCancelCalls = 2
)
View Source 
const (
	// The version of the orbit protocol.
	Version = 3
)

Variables

View Source 
var (
	Codec = msgpack.Codec
)

Functions

This section is empty.

Types

type HandshakeArgs added in v0.2.0 

type HandshakeArgs struct {
	Version byte
}

func (*HandshakeArgs) DecodeMsg added in v0.2.0 

func (z *HandshakeArgs) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HandshakeArgs) EncodeMsg added in v0.2.0 

func (z HandshakeArgs) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HandshakeArgs) MarshalMsg added in v0.2.0 

func (z HandshakeArgs) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HandshakeArgs) Msgsize added in v0.2.0 

func (z HandshakeArgs) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HandshakeArgs) UnmarshalMsg added in v0.2.0 

func (z *HandshakeArgs) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HandshakeCode added in v0.2.0 

type HandshakeCode int
const (
	HSOk             HandshakeCode = 0
	HSInvalidVersion HandshakeCode = 1
)

func (*HandshakeCode) DecodeMsg added in v0.2.0 

func (z *HandshakeCode) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HandshakeCode) EncodeMsg added in v0.2.0 

func (z HandshakeCode) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HandshakeCode) MarshalMsg added in v0.2.0 

func (z HandshakeCode) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HandshakeCode) Msgsize added in v0.2.0 

func (z HandshakeCode) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HandshakeCode) UnmarshalMsg added in v0.2.0 

func (z *HandshakeCode) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HandshakeRet added in v0.2.0 

type HandshakeRet struct {
	Code      HandshakeCode
	SessionID string
}

func (*HandshakeRet) DecodeMsg added in v0.2.0 

func (z *HandshakeRet) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HandshakeRet) EncodeMsg added in v0.2.0 

func (z HandshakeRet) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HandshakeRet) MarshalMsg added in v0.2.0 

func (z HandshakeRet) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HandshakeRet) Msgsize added in v0.2.0 

func (z HandshakeRet) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HandshakeRet) UnmarshalMsg added in v0.2.0 

func (z *HandshakeRet) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RPCCall added in v0.3.0 

type RPCCall struct {
	ID   string
	Key  uint32
	Data map[string][]byte
}

func (*RPCCall) DecodeMsg added in v0.3.0 

func (z *RPCCall) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*RPCCall) EncodeMsg added in v0.3.0 

func (z *RPCCall) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*RPCCall) MarshalMsg added in v0.3.0 

func (z *RPCCall) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*RPCCall) Msgsize added in v0.3.0 

func (z *RPCCall) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RPCCall) UnmarshalMsg added in v0.3.0 

func (z *RPCCall) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RPCCancel added in v0.3.0 

type RPCCancel struct {
	Key uint32
}

func (*RPCCancel) DecodeMsg added in v0.3.0 

func (z *RPCCancel) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (RPCCancel) EncodeMsg added in v0.3.0 

func (z RPCCancel) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (RPCCancel) MarshalMsg added in v0.3.0 

func (z RPCCancel) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (RPCCancel) Msgsize added in v0.3.0 

func (z RPCCancel) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RPCCancel) UnmarshalMsg added in v0.3.0 

func (z *RPCCancel) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RPCReturn added in v0.3.0 

type RPCReturn struct {
	Key     uint32
	Err     string
	ErrCode int
}

func (*RPCReturn) DecodeMsg added in v0.3.0 

func (z *RPCReturn) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (RPCReturn) EncodeMsg added in v0.3.0 

func (z RPCReturn) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (RPCReturn) MarshalMsg added in v0.3.0 

func (z RPCReturn) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (RPCReturn) Msgsize added in v0.3.0 

func (z RPCReturn) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RPCReturn) UnmarshalMsg added in v0.3.0 

func (z *RPCReturn) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RPCType added in v0.3.0 

type RPCType byte
const (
	RPCTypeCall   RPCType = 0
	RPCTypeReturn RPCType = 1
	RPCTypeCancel RPCType = 2
)

func (*RPCType) DecodeMsg added in v0.3.0 

func (z *RPCType) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (RPCType) EncodeMsg added in v0.3.0 

func (z RPCType) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (RPCType) MarshalMsg added in v0.3.0 

func (z RPCType) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (RPCType) Msgsize added in v0.3.0 

func (z RPCType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RPCType) UnmarshalMsg added in v0.3.0 

func (z *RPCType) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type StreamAsync added in v0.3.1 

type StreamAsync struct {
	ID string
}

func (*StreamAsync) DecodeMsg added in v0.3.1 

func (z *StreamAsync) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (StreamAsync) EncodeMsg added in v0.3.1 

func (z StreamAsync) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (StreamAsync) MarshalMsg added in v0.3.1 

func (z StreamAsync) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (StreamAsync) Msgsize added in v0.3.1 

func (z StreamAsync) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*StreamAsync) UnmarshalMsg added in v0.3.1 

func (z *StreamAsync) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type StreamRaw added in v0.3.1 

type StreamRaw struct {
	ID   string
	Data map[string][]byte
}

func (*StreamRaw) DecodeMsg added in v0.3.1 

func (z *StreamRaw) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*StreamRaw) EncodeMsg added in v0.3.1 

func (z *StreamRaw) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*StreamRaw) MarshalMsg added in v0.3.1 

func (z *StreamRaw) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*StreamRaw) Msgsize added in v0.3.1 

func (z *StreamRaw) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*StreamRaw) UnmarshalMsg added in v0.3.1 

func (z *StreamRaw) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type StreamType added in v0.2.0 

type StreamType byte

func (*StreamType) DecodeMsg added in v0.2.0 

func (z *StreamType) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (StreamType) EncodeMsg added in v0.2.0 

func (z StreamType) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (StreamType) MarshalMsg added in v0.2.0 

func (z StreamType) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (StreamType) Msgsize added in v0.2.0 

func (z StreamType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*StreamType) UnmarshalMsg added in v0.2.0 

func (z *StreamType) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TypedStreamError added in v1.5.0 

type TypedStreamError struct {
	Err  string
	Code int
}

type TypedStreamType added in v1.5.0 

type TypedStreamType byte
const (
	TypedStreamTypeData  TypedStreamType = 0
	TypedStreamTypeError TypedStreamType = 1
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.