Class NetMQMessageCodec

Inheritance

Object

NetMQMessageCodec

Implements

IMessageCodec<NetMQMessage>

Namespace: Libplanet.Net.Messages

Assembly: Libplanet.Net.dll

Syntax

public class NetMQMessageCodec : object, IMessageCodec<NetMQMessage>

Constructors

NetMQMessageCodec()

Creates a NetMQMessageCodec instance.

Declaration

public NetMQMessageCodec()

Methods

Decode(NetMQMessage, Boolean)

Decodes given -typed encoded into Message and checks its validity. Encode(Message, PrivateKey, AppProtocolVersion, BoundPeer, DateTimeOffset)

Declaration

public Message Decode(NetMQMessage encoded, bool reply)

Parameters

Type	Name	Description
NetMQMessage	encoded
Boolean	reply	A flag to express whether the target is a reply of other message.

Returns

Type	Description
Message	A Message parsed from encoded.

Exceptions

Type	Condition
InvalidMessageSignatureException	Thrown when the signer of encoded is invalid.

Encode(Message, PrivateKey, AppProtocolVersion, BoundPeer, DateTimeOffset)

Encodes the message to -typed instance with given privateKey and peer.

Declaration

public NetMQMessage Encode(Message message, PrivateKey privateKey, AppProtocolVersion appProtocolVersion, BoundPeer peer, DateTimeOffset timestamp)

Parameters

Type	Name	Description
Message	message	The message to encode.
PrivateKey	privateKey	The PrivateKey to sign the encoded message.
AppProtocolVersion	appProtocolVersion	The AppProtocolVersion of the transport layer.
BoundPeer	peer	The BoundPeer-typed representation of the transport layer. AsPeer
DateTimeOffset	timestamp	The of the time message is encoded.

Returns

Type	Description
NetMQMessage	A containing the signed Message.

Exceptions

Type	Condition
InvalidCredentialException	Thrown when privateKey's PublicKey does not match that of peer.

Implements

IMessageCodec<T>