Documentation
¶
Overview ¶
Package protocol contains the specification and implementation of the GueaaS protocol.
This package contains the implementation of the generic handshake between the GueaaS client and the GueaaS server. During the handshake, the specific protocol to be used for the connection is negotiated between server and client.
The specific protocols are specified and implemented in sub-packages of this package.
Index ¶
- type Header
- func (z *Header) DecodeMsg(dc *msgp.Reader) (err error)
- func (z Header) EncodeMsg(en *msgp.Writer) (err error)
- func (z Header) MarshalMsg(b []byte) (o []byte, err error)
- func (h *Header) MarshalTo(msg *mangos.Message) error
- func (z Header) Msgsize() (s int)
- func (h *Header) UnmarshalFrom(msg *mangos.Message) error
- func (z *Header) UnmarshalMsg(bts []byte) (o []byte, err error)
- type MessageType
- type Protocol
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Header ¶
type Header struct {
Protocol Protocol `msg:"p"`
MessageType MessageType `msg:"t"`
}
func (Header) MarshalMsg ¶
MarshalMsg implements msgp.Marshaler
func (Header) Msgsize ¶
Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message
func (*Header) UnmarshalFrom ¶
type MessageType ¶
type MessageType uint64
func (*MessageType) DecodeMsg ¶
func (z *MessageType) DecodeMsg(dc *msgp.Reader) (err error)
DecodeMsg implements msgp.Decodable
func (MessageType) EncodeMsg ¶
func (z MessageType) EncodeMsg(en *msgp.Writer) (err error)
EncodeMsg implements msgp.Encodable
func (MessageType) MarshalMsg ¶
func (z MessageType) MarshalMsg(b []byte) (o []byte, err error)
MarshalMsg implements msgp.Marshaler
func (MessageType) Msgsize ¶
func (z MessageType) Msgsize() (s int)
Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message
func (*MessageType) UnmarshalMsg ¶
func (z *MessageType) UnmarshalMsg(bts []byte) (o []byte, err error)
UnmarshalMsg implements msgp.Unmarshaler
type Protocol ¶
type Protocol string
const (
ProtocolV1 Protocol = "v1"
)
func (Protocol) MarshalMsg ¶
MarshalMsg implements msgp.Marshaler
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package common contains data structures and message parts not specific to a single protocol.
|
Package common contains data structures and message parts not specific to a single protocol. |
|
Package v1 contains the GueaaS v1 protocol implementation.
|
Package v1 contains the GueaaS v1 protocol implementation. |