Documentation ¶
Overview ¶
Package msg is 100% generated. If you edit this file, you will lose your changes at the next build cycle. DO NOT MAKE ANY CHANGES YOU WISH TO KEEP.
The correct places for commits are:
- The XML model used for this code generation: zre_msg.xml
- The code generation script that built this file: zproto_codec_go
Index ¶
- Constants
- type Hello
- func (h *Hello) Marshal() ([]byte, error)
- func (h *Hello) RoutingId() []byte
- func (h *Hello) Send(socket *zmq.Socket) (err error)
- func (h *Hello) Sequence() uint16
- func (h *Hello) SetRoutingId(routingId []byte)
- func (h *Hello) SetSequence(sequence uint16)
- func (h *Hello) SetVersion(version byte)
- func (h *Hello) String() string
- func (h *Hello) Unmarshal(frames ...[]byte) error
- func (h *Hello) Version() byte
- type Join
- func (j *Join) Marshal() ([]byte, error)
- func (j *Join) RoutingId() []byte
- func (j *Join) Send(socket *zmq.Socket) (err error)
- func (j *Join) Sequence() uint16
- func (j *Join) SetRoutingId(routingId []byte)
- func (j *Join) SetSequence(sequence uint16)
- func (j *Join) SetVersion(version byte)
- func (j *Join) String() string
- func (j *Join) Unmarshal(frames ...[]byte) error
- func (j *Join) Version() byte
- type Leave
- func (l *Leave) Marshal() ([]byte, error)
- func (l *Leave) RoutingId() []byte
- func (l *Leave) Send(socket *zmq.Socket) (err error)
- func (l *Leave) Sequence() uint16
- func (l *Leave) SetRoutingId(routingId []byte)
- func (l *Leave) SetSequence(sequence uint16)
- func (l *Leave) SetVersion(version byte)
- func (l *Leave) String() string
- func (l *Leave) Unmarshal(frames ...[]byte) error
- func (l *Leave) Version() byte
- type Ping
- func (p *Ping) Marshal() ([]byte, error)
- func (p *Ping) RoutingId() []byte
- func (p *Ping) Send(socket *zmq.Socket) (err error)
- func (p *Ping) Sequence() uint16
- func (p *Ping) SetRoutingId(routingId []byte)
- func (p *Ping) SetSequence(sequence uint16)
- func (p *Ping) SetVersion(version byte)
- func (p *Ping) String() string
- func (p *Ping) Unmarshal(frames ...[]byte) error
- func (p *Ping) Version() byte
- type PingOk
- func (p *PingOk) Marshal() ([]byte, error)
- func (p *PingOk) RoutingId() []byte
- func (p *PingOk) Send(socket *zmq.Socket) (err error)
- func (p *PingOk) Sequence() uint16
- func (p *PingOk) SetRoutingId(routingId []byte)
- func (p *PingOk) SetSequence(sequence uint16)
- func (p *PingOk) SetVersion(version byte)
- func (p *PingOk) String() string
- func (p *PingOk) Unmarshal(frames ...[]byte) error
- func (p *PingOk) Version() byte
- type Shout
- func (s *Shout) Marshal() ([]byte, error)
- func (s *Shout) RoutingId() []byte
- func (s *Shout) Send(socket *zmq.Socket) (err error)
- func (s *Shout) Sequence() uint16
- func (s *Shout) SetRoutingId(routingId []byte)
- func (s *Shout) SetSequence(sequence uint16)
- func (s *Shout) SetVersion(version byte)
- func (s *Shout) String() string
- func (s *Shout) Unmarshal(frames ...[]byte) error
- func (s *Shout) Version() byte
- type Transit
- type Whisper
- func (w *Whisper) Marshal() ([]byte, error)
- func (w *Whisper) RoutingId() []byte
- func (w *Whisper) Send(socket *zmq.Socket) (err error)
- func (w *Whisper) Sequence() uint16
- func (w *Whisper) SetRoutingId(routingId []byte)
- func (w *Whisper) SetSequence(sequence uint16)
- func (w *Whisper) SetVersion(version byte)
- func (w *Whisper) String() string
- func (w *Whisper) Unmarshal(frames ...[]byte) error
- func (w *Whisper) Version() byte
Constants ¶
const ( HelloId uint8 = 1 WhisperId uint8 = 2 ShoutId uint8 = 3 JoinId uint8 = 4 LeaveId uint8 = 5 PingId uint8 = 6 PingOkId uint8 = 7 )
const (
Signature uint16 = 0xAAA0 | 0
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Hello ¶
type Hello struct { Endpoint string Groups []string Status byte Name string Headers map[string]string // contains filtered or unexported fields }
Greet a peer so it can connect back to us
func (*Hello) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Hello) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Hello) SetSequence ¶
Setsequence sets the sequence.
type Join ¶
Join a group
func (*Join) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Join) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Join) SetSequence ¶
Setsequence sets the sequence.
type Leave ¶
Leave a group
func (*Leave) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Leave) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Leave) SetSequence ¶
Setsequence sets the sequence.
type Ping ¶
type Ping struct {
// contains filtered or unexported fields
}
Ping a peer that has gone silent
func (*Ping) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Ping) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Ping) SetSequence ¶
Setsequence sets the sequence.
type PingOk ¶
type PingOk struct {
// contains filtered or unexported fields
}
Reply to a peer's ping
func (*PingOk) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*PingOk) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*PingOk) SetSequence ¶
Setsequence sets the sequence.
type Shout ¶
Send a multi-part message to a group
func (*Shout) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Shout) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Shout) SetSequence ¶
Setsequence sets the sequence.
type Transit ¶
type Transit interface { Marshal() ([]byte, error) Unmarshal(...[]byte) error String() string Send(*zmq.Socket) error SetRoutingId([]byte) RoutingId() []byte SetVersion(byte) Version() byte SetSequence(uint16) Sequence() uint16 }
func RecvNoWait ¶
Receives marshaled data from 0mq socket. It won't wait for input.
type Whisper ¶
type Whisper struct { Content []byte // contains filtered or unexported fields }
Send a multi-part message to a peer
func (*Whisper) RoutingId ¶
RoutingId returns the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Whisper) SetRoutingId ¶
SetRoutingId sets the routingId for this message, routingId should be set whenever talking to a ROUTER.
func (*Whisper) SetSequence ¶
Setsequence sets the sequence.
func (*Whisper) SetVersion ¶
Setversion sets the version.