C# Class NetMQ.Zyre.ZreMsg

work with ZRE messages

Mostrar archivo Open project: NetMQ/Zyre Class Usage Examples

Public Methods

Method	Description
GetUuid ( byte buffer, int offset ) : System.Guid
Receive ( IReceivingSocket input ) : bool	Receive a ZreMsg from the socket. Message is ignored if the message signature doesn't start with %xAA %xA1 (returns false). It appears "real" input will always be a RouterSocket, but DealerSocket is used during unit testing by zeromq/zyre and by this implementation.
ReceiveNew ( NetMQ.Sockets.RouterSocket input, System.Guid &uuid ) : ZreMsg	Return a new ZreMsg based received from the input socket. Message is ignored if input is a RouterSocket and the message header doesn't meet the http://rfc.zeromq.org/spec:36 spec. Message is ignored if the message signature doesn't start with %xAA %xA1.
Send ( IOutgoingSocket output ) : bool	Send the ZreMsg to the socket. Warning re WHISPER and SHOUT: The 0MQ spec http://rfc.zeromq.org/spec:36 says "message content defined as one 0MQ frame. ZRE does not support multi-frame message contents." ...on the other hand, it appears that zeromq/zyre also supports multi-frame contents, as per the top of zyre.c This C# implementation allows multi-frame contents.
SendHello ( IOutgoingSocket socket, string endpoint, List groups, byte status, string name, string>.Dictionary headers ) : bool	Send a Hello message to the socket
SendJoin ( IOutgoingSocket socket, ushort sequence, string group, byte status ) : bool	Send a Join message to the socket
SendLeave ( IOutgoingSocket socket, ushort sequence, string group, byte status ) : bool	Send a Leave message to the socket
SendPing ( IOutgoingSocket socket, ushort sequence ) : bool	Send a Ping message to the socket
SendPingOk ( IOutgoingSocket socket, ushort sequence ) : bool	Send a PingOk message to the socket
SendShout ( IOutgoingSocket socket, ushort sequence, NetMQMessage content ) : bool	Send a Shout message to the socket Warning re WHISPER and SHOUT: The 0MQ spec http://rfc.zeromq.org/spec:36 says "message content defined as one 0MQ frame. ZRE does not support multi-frame message contents." ...on the other hand, it appears that zeromq/zyre also supports multi-frame contents, as per the top of zyre.c This C# implementation allows multi-frame contents.
SendWhisper ( IOutgoingSocket socket, ushort sequence, NetMQMessage content ) : bool	Send a Whisper message to the socket Warning re WHISPER and SHOUT: The 0MQ spec http://rfc.zeromq.org/spec:36 says "message content defined as one 0MQ frame. ZRE does not support multi-frame message contents." ...on the other hand, it appears that zeromq/zyre also supports multi-frame contents, as per the top of zyre.c This C# implementation allows multi-frame contents.
ToString ( ) : string
ZreMsg ( ) : System	Create a new ZreMsg

Private Methods

Method	Description
GetLongString ( ) : string
GetNumber1 ( ) : byte
GetNumber2 ( ) : UInt16
GetNumber4 ( ) : UInt32
GetNumber8 ( ) : System.UInt64
GetOctets ( byte host, int size ) : void
GetString ( ) : string
PutLongString ( string host ) : void
PutNumber1 ( byte host ) : void
PutNumber2 ( UInt16 host ) : void
PutNumber4 ( UInt32 host ) : void
PutNumber8 ( System.UInt64 host ) : void
PutOctets ( byte host, int size ) : void
PutString ( string host ) : void

Method Details

GetUuid() public static method

public static GetUuid ( byte buffer, int offset ) : System.Guid
buffer	byte
offset	int
return	System.Guid

Receive() public method

Receive a ZreMsg from the socket. Message is ignored if the message signature doesn't start with %xAA %xA1 (returns false). It appears "real" input will always be a RouterSocket, but DealerSocket is used during unit testing by zeromq/zyre and by this implementation.

public Receive ( IReceivingSocket input ) : bool
input	IReceivingSocket	the socket
return	bool

ReceiveNew() public static method

Return a new ZreMsg based received from the input socket. Message is ignored if input is a RouterSocket and the message header doesn't meet the http://rfc.zeromq.org/spec:36 spec. Message is ignored if the message signature doesn't start with %xAA %xA1.

public static ReceiveNew ( NetMQ.Sockets.RouterSocket input, System.Guid &uuid ) : ZreMsg
input	NetMQ.Sockets.RouterSocket	the socket
uuid	System.Guid	The identity Guid received into the RoutingId, or Guid.Empty
return	ZreMsg

Send() public method

Send the ZreMsg to the socket. Warning re WHISPER and SHOUT: The 0MQ spec http://rfc.zeromq.org/spec:36 says "message content defined as one 0MQ frame. ZRE does not support multi-frame message contents." ...on the other hand, it appears that zeromq/zyre also supports multi-frame contents, as per the top of zyre.c This C# implementation allows multi-frame contents.

public Send ( IOutgoingSocket output ) : bool
output	IOutgoingSocket
return	bool

SendHello() public static method

Send a Hello message to the socket

public static SendHello ( IOutgoingSocket socket, string endpoint, List groups, byte status, string name, string>.Dictionary headers ) : bool
socket	IOutgoingSocket
endpoint	string
groups	List
status	byte
name	string
headers	string>.Dictionary
return	bool

SendJoin() public static method

Send a Join message to the socket

public static SendJoin ( IOutgoingSocket socket, ushort sequence, string group, byte status ) : bool
socket	IOutgoingSocket
sequence	ushort
group	string
status	byte
return	bool

SendLeave() public static method

Send a Leave message to the socket

public static SendLeave ( IOutgoingSocket socket, ushort sequence, string group, byte status ) : bool
socket	IOutgoingSocket
sequence	ushort
group	string
status	byte
return	bool

SendPing() public static method

Send a Ping message to the socket

public static SendPing ( IOutgoingSocket socket, ushort sequence ) : bool
socket	IOutgoingSocket
sequence	ushort
return	bool

SendPingOk() public static method

Send a PingOk message to the socket

public static SendPingOk ( IOutgoingSocket socket, ushort sequence ) : bool
socket	IOutgoingSocket
sequence	ushort
return	bool

SendShout() public static method

Send a Shout message to the socket Warning re WHISPER and SHOUT: The 0MQ spec http://rfc.zeromq.org/spec:36 says "message content defined as one 0MQ frame. ZRE does not support multi-frame message contents." ...on the other hand, it appears that zeromq/zyre also supports multi-frame contents, as per the top of zyre.c This C# implementation allows multi-frame contents.

public static SendShout ( IOutgoingSocket socket, ushort sequence, NetMQMessage content ) : bool
socket	IOutgoingSocket
sequence	ushort
content	NetMQMessage	See warning above
return	bool

SendWhisper() public static method

Send a Whisper message to the socket Warning re WHISPER and SHOUT: The 0MQ spec http://rfc.zeromq.org/spec:36 says "message content defined as one 0MQ frame. ZRE does not support multi-frame message contents." ...on the other hand, it appears that zeromq/zyre also supports multi-frame contents, as per the top of zyre.c This C# implementation allows multi-frame contents.

public static SendWhisper ( IOutgoingSocket socket, ushort sequence, NetMQMessage content ) : bool
socket	IOutgoingSocket
sequence	ushort
content	NetMQMessage	See warning above
return	bool

ToString() public method

public ToString ( ) : string
return	string

ZreMsg() public method

Create a new ZreMsg

public ZreMsg ( ) : System
return	System