Package org.drasyl.handler.remote.protocol

Interface RemoteMessage

All Known Subinterfaces:

FullReadMessage<T>, PartialReadMessage

All Known Implementing Classes:

AcknowledgementMessage, ApplicationMessage, ArmedProtocolMessage, HelloMessage, UnarmedProtocolMessage, UniteMessage

@UnstableApi
public interface RemoteMessage

Describes a message that is sent to remote peers via UDP/TCP.

Each message is made up of several parts:

• A fixed-length magic number used to identity if message belongs to the drasyl protocol.
• A fixed-length public header with partly authenticated information required for routing the message to its destination.
• An armed-dependent fixed-length private header with encrypted information only readable by the recipient.
• A variable-length body with message type specific (encrypted) information.

     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |               Magic Number (4 Bytes)                |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |      PublicHeader (PublicHeader.LENGTH Bytes)       |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |       PrivateHeader (PrivateHeader.LENGTH or        |
     |          PrivateHeader.ARMED_LENGTH Bytes)          |
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     /     Body (HelloMessage, ApplicationMessage,     /
     \      AcknowledgementMessage, or UniteMessage)       \
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAGIC_NUMBER
static final int	MAGIC_NUMBER_LEN

Method Summary

Modifier and Type	Method	Description
io.netty.buffer.ByteBuf	encodeMessage(io.netty.buffer.ByteBufAllocator alloc)	Writes this message to a buffer created by alloc.
boolean	getArmed()
HopCount	getHopCount()
int	getLength()
int	getNetworkId()
Nonce	getNonce()
ProofOfWork	getProofOfWork()
DrasylAddress	getRecipient()
DrasylAddress	getSender()
RemoteMessage	incrementHopCount()	Returns a copy of this message with incremented getHopCount().

Field Details

MAGIC_NUMBER

static final int MAGIC_NUMBER

See Also:

• Constant Field Values

MAGIC_NUMBER_LEN

static final int MAGIC_NUMBER_LEN

See Also:

• Constant Field Values

Method Details

getNonce

Nonce getNonce()

getNetworkId

int getNetworkId()

getSender

DrasylAddress getSender()

getProofOfWork

ProofOfWork getProofOfWork()

getRecipient

DrasylAddress getRecipient()

getHopCount

HopCount getHopCount()

getArmed

boolean getArmed()

incrementHopCount

RemoteMessage incrementHopCount()

Returns a copy of this message with incremented getHopCount().

Returns:

message with incremented hop count

Throws:

IllegalStateException - if incremented hop count is greater then HopCount.MAX_HOP_COUNT

encodeMessage

io.netty.buffer.ByteBuf encodeMessage(io.netty.buffer.ByteBufAllocator alloc)

Writes this message to a buffer created by alloc.

Parameters:

out - writes this envelope to a buffer created by the given allocator

Returns:

the buffer written to

getLength

int getLength()