api

package

v0.2.0 Latest Latest Go to latest Published: Feb 9, 2020 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/desertbit/orbit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api contains types that are internally used to send data via the control and signaler pkg.

Constants ¶

View Source

const (
	// The version of the application.
	Version = 1
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ControlCall ¶

type ControlCall struct {
	ID         string
	Key        uint64
	Cancelable bool
}

func (*ControlCall) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (ControlCall) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (ControlCall) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (ControlCall) Msgsize ¶

func (z ControlCall) Msgsize() (s int)

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

func (*ControlCall) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

type ControlCancel ¶

type ControlCancel struct {
	Key uint64
}

func (*ControlCancel) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (ControlCancel) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (ControlCancel) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (ControlCancel) Msgsize ¶

func (z ControlCancel) Msgsize() (s int)

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

func (*ControlCancel) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

type ControlReturn ¶

type ControlReturn struct {
	Key  uint64
	Msg  string
	Code int
}

func (*ControlReturn) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (ControlReturn) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (ControlReturn) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (ControlReturn) Msgsize ¶

func (z ControlReturn) Msgsize() (s int)

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

func (*ControlReturn) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

type InitStream ¶

type InitStream struct {
	Channel string
}

func (*InitStream) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (InitStream) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (InitStream) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (InitStream) Msgsize ¶

func (z InitStream) Msgsize() (s int)

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

func (*InitStream) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

type SetSignal ¶

type SetSignal struct {
	ID     string
	Active bool
}

func (*SetSignal) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (SetSignal) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (SetSignal) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (SetSignal) Msgsize ¶

func (z SetSignal) Msgsize() (s int)

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

func (*SetSignal) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

type SetSignalFilter ¶

type SetSignalFilter struct {
	ID   string
	Data []byte
}

func (*SetSignalFilter) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (*SetSignalFilter) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (*SetSignalFilter) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (*SetSignalFilter) Msgsize ¶

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

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

func (*SetSignalFilter) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

type TriggerSignal ¶

type TriggerSignal struct {
	ID   string
	Data []byte
}

func (*TriggerSignal) DecodeMsg ¶

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

DecodeMsg implements msgp.Decodable

func (*TriggerSignal) EncodeMsg ¶

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

EncodeMsg implements msgp.Encodable

func (*TriggerSignal) MarshalMsg ¶

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

MarshalMsg implements msgp.Marshaler

func (*TriggerSignal) Msgsize ¶

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

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

func (*TriggerSignal) UnmarshalMsg ¶

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

UnmarshalMsg implements msgp.Unmarshaler

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL