Class MessageCache

Cache object that stores recently seen Messages.

Inheritance

Object

MessageCache

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Libplanet.Net.Consensus

Assembly: Libplanet.Net.dll

Syntax

public class MessageCache

Constructors

MessageCache()

Create a message cache instance that stores recently seen Messages for gossip.

Declaration

public MessageCache()

Methods

Clear()

Clears Libplanet.Net.Consensus.MessageCache._messages.

Declaration

public void Clear()

DiffFrom(IEnumerable<MessageId>)

Gets the array of MessageId of set difference ids - Libplanet.Net.Consensus.MessageCache._messages.

Declaration

[Pure]
public MessageId[] DiffFrom(IEnumerable<MessageId> ids)

Parameters

Type	Name	Description
IEnumerable<MessageId>	ids	MessageIds of the Messages to calculate difference from.

Returns

Type	Description
MessageId[]	Result of set difference operation.

Get(MessageId)

Gets copied value of the message with id if it exists in the message cache.

Declaration

[Pure]
public MessageContent Get(MessageId id)

Parameters

Type	Name	Description
MessageId	id	A MessageId of the Message to get.

Returns

Type	Description
MessageContent	A message with id id.

Exceptions

Type	Condition
KeyNotFoundException	Thrown when a Message of id id does not exist in the message cache.

GetGossipIds()

Selects at maximum gossip messages used for gossiping.

Declaration

[Pure]
public MessageId[] GetGossipIds()

Returns

Type	Description
MessageId[]	A list of message ids to gossip.

Put(MessageContent)

Puts the message into message cache.

Declaration

public void Put(MessageContent message)

Parameters

Type	Name	Description
MessageContent	message	A Message to cache.

Exceptions

Type	Condition
ArgumentException	Thrown when a Message with the same id already exists.