Interface IMessageCodec<T>

Namespace: Libplanet.Net.Messages

Assembly: Libplanet.Net.dll

Syntax

public interface IMessageCodec<T>

Type Parameters

Name	Description
T

Methods

Decode(T, Boolean)

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

Declaration

Message Decode(T encoded, bool reply)

Parameters

Type	Name	Description
T	encoded	A -typed instance to parse.
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
ArgumentException	Thrown when empty encoded is given.
InvalidMessageSignatureException	Thrown when the signer of encoded is invalid.

Encode(MessageContent, PrivateKey, AppProtocolVersion, BoundPeer, DateTimeOffset, Byte[])

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

Declaration

T Encode(MessageContent content, PrivateKey privateKey, AppProtocolVersion appProtocolVersion, BoundPeer peer, DateTimeOffset timestamp, byte[] identity)

Parameters

Type	Name	Description
MessageContent	content	The message body 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 DateTimeOffset of the time content is encoded.
Byte[]	identity	The byte array identifies the message to match between message and its respond used in NetMQ.

Returns

Type	Description
T	A containing the signed MessageContent.

Exceptions

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