Package convex.net

Enum Class MessageType

java.lang.Object

java.lang.Enum<MessageType>

convex.net.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>, Constable

public enum MessageType
extends Enum<MessageType>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BELIEF	Communication of a latest Belief by a Peer.
CHALLENGE	A message that requests the remote endpoint to respond with a signed response.
COMMAND	A control command to a peer.
DATA	A message relaying data.
GOODBYE	Communication of an intention to shutdown the connection.
QUERY	A request to perform the specified query and return results.
REQUEST_BELIEF	Request the latest Belief from a Peer.
REQUEST_DATA	A request to provide data.
RESPONSE	A response to a challenge.
RESULT	Message containing the Result for a corresponding COMMAND, QUERY or TRANSACT message.
STATUS	Request for a peer status update.
TRANSACT	A message requesting a transaction be accepted by the receiving peer and included in the next available block.

Method Summary

Modifier and Type	Method	Description
static MessageType	decode(int i)
byte	getMessageCode()
static MessageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHALLENGE

public static final MessageType CHALLENGE

A message that requests the remote endpoint to respond with a signed response. The challenge must be signed to authenticate the challenger. The challenge is sent with a vector of [hash accountKey-of-the-challenged]

RESPONSE

public static final MessageType RESPONSE

A response to a challenge. The challengee must sign the response as proof of possession of the claimed address.

DATA

public static final MessageType DATA

A message relaying data. Payload is a vector: - [id content] Data is presented "as-is", and may be: - the result of a missing data request - data sent ahead of another message requiring composite data

COMMAND

public static final MessageType COMMAND

A control command to a peer. Should only be accepted and acted upon when originating from trusted, authenticated senders.

REQUEST_DATA

public static final MessageType REQUEST_DATA

A request to provide data. Peers should not send this message unless both: a) they are unable to locate the given data in their local store b) They have reason to believe the targeted peer may be able to provide it Excessive invalid data requests may be considered a DoS attack by peers. Peers under load may ignore data requests. Payload is a Vector containing ID plus one or more hashes i.e [id hash1 hash2 ......] Receiver should respond with a DATA message if the specified data is available in their store, and they are willing to fulfil the request

QUERY

public static final MessageType QUERY

A request to perform the specified query and return results. Payload is: [id form address?] Receiver may may determine policies regarding whether to accept or reject queries, typically receiver will want to authenticate the sender and ensure good standing?

TRANSACT

public static final MessageType TRANSACT

A message requesting a transaction be accepted by the receiving peer and included in the next available block. Payload is: [id signed-data]

RESULT

public static final MessageType RESULT

Message containing the Result for a corresponding COMMAND, QUERY or TRANSACT message. Payload is: [id result error-code] Where: - Result is the result of the request, or the message if an error occurred - error-code is nil if the transaction succeeded, or error code if it failed

BELIEF

public static final MessageType BELIEF

Communication of a latest Belief by a Peer. Payload is a Belief or a Signed Order, which is expected to be a Partial update

REQUEST_BELIEF

public static final MessageType REQUEST_BELIEF

Request the latest Belief from a Peer. Payload is: - nil for the latest Belief or Order - Long value for a specific Block in the Peer's Order.

GOODBYE

public static final MessageType GOODBYE

Communication of an intention to shutdown the connection. This is optional Payload can be: - nil for no reason - A human readable string as a reason

STATUS

public static final MessageType STATUS

Request for a peer status update. Payload is the message ID as a Long. Expected Result is a Vector: [signed-belief-hash states-hash initial-state-hash peer-key consensus-state-hash]

Method Details

values

public static MessageType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MessageType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getMessageCode

public byte getMessageCode()

decode

public static MessageType decode(int i)
                          throws BadFormatException

Throws:

BadFormatException