Package org.drasyl.handler.remote.protocol

Class UnarmedProtocolMessage

java.lang.Object

org.drasyl.handler.remote.protocol.UnarmedProtocolMessage

All Implemented Interfaces:

io.netty.util.ReferenceCounted, AutoCloseable, PartialReadMessage, RemoteMessage

@UnstableApi
public abstract class UnarmedProtocolMessage
extends Object
implements PartialReadMessage

Describes an unencrypted protocol message whose only public header has been read so far.

read() can be used to read the message's remainder.

Field Summary

Fields inherited from interface org.drasyl.handler.remote.protocol.RemoteMessage

MAGIC_NUMBER, MAGIC_NUMBER_LEN

Constructor Summary

Constructors

Constructor	Description
UnarmedProtocolMessage()

Method Summary

Modifier and Type	Method	Description
ArmedProtocolMessage	arm(io.netty.buffer.ByteBufAllocator alloc, Crypto cryptoInstance, SessionPair sessionPair)	Returns an armed version (ArmedProtocolMessage) of this message.
ArmedProtocolMessage	armAndRelease(io.netty.buffer.ByteBufAllocator alloc, Crypto cryptoInstance, SessionPair sessionPair)	Returns an armed version (ArmedProtocolMessage) of this message and then releases this message.
UnarmedProtocolMessage	asReadOnly()	Returns a read-only version of this message.
void	close()	Calls ReferenceCounted.release().
io.netty.buffer.ByteBuf	encodeMessage(io.netty.buffer.ByteBufAllocator alloc)	Writes this message to a buffer created by alloc.
int	getLength()
abstract DrasylAddress	getRecipient()
UnarmedProtocolMessage	incrementHopCount()	Returns a copy of this message with incremented RemoteMessage.getHopCount().
boolean	isReadOnly()	Returns true if and only if this message is read-only.
static UnarmedProtocolMessage	of(HopCount hopCount, boolean isArmed, int networkId, Nonce nonce, DrasylAddress recipient, DrasylAddress sender, ProofOfWork proofOfWork, io.netty.buffer.ByteBuf bytes)	Creates an unarmed message.
FullReadMessage<?>	read()	Read the remainder of this message and returns the resulted FullReadMessage.
int	refCnt()
boolean	release()
boolean	release(int decrement)
UnarmedProtocolMessage	retain()
UnarmedProtocolMessage	retain(int increment)
UnarmedProtocolMessage	touch()
UnarmedProtocolMessage	touch(Object hint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.drasyl.handler.remote.protocol.PartialReadMessage

getBytes

Methods inherited from interface org.drasyl.handler.remote.protocol.RemoteMessage

getArmed, getHopCount, getNetworkId, getNonce, getProofOfWork, getSender

Constructor Details

UnarmedProtocolMessage

public UnarmedProtocolMessage()

Method Details

getRecipient

@Nullable
public abstract DrasylAddress getRecipient()

Specified by:

getRecipient in interface RemoteMessage

close

public void close()

Description copied from interface: PartialReadMessage

Calls ReferenceCounted.release().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PartialReadMessage

refCnt

public int refCnt()

Specified by:

refCnt in interface io.netty.util.ReferenceCounted

retain

public UnarmedProtocolMessage retain()

Specified by:

retain in interface io.netty.util.ReferenceCounted

retain

public UnarmedProtocolMessage retain(int increment)

Specified by:

retain in interface io.netty.util.ReferenceCounted

touch

public UnarmedProtocolMessage touch()

Specified by:

touch in interface io.netty.util.ReferenceCounted

touch

public UnarmedProtocolMessage touch(Object hint)

Specified by:

touch in interface io.netty.util.ReferenceCounted

release

public boolean release()

Specified by:

release in interface io.netty.util.ReferenceCounted

release

public boolean release(int decrement)

Specified by:

release in interface io.netty.util.ReferenceCounted

incrementHopCount

public UnarmedProtocolMessage incrementHopCount()

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

ReferenceCounted.release() ownership of getBytes() is transferred to this PartialReadMessage.

Specified by:

incrementHopCount in interface RemoteMessage

Returns:

message with incremented hop count

encodeMessage

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

Description copied from interface: RemoteMessage

Writes this message to a buffer created by alloc.

Specified by:

encodeMessage in interface RemoteMessage

Returns:

the buffer written to

getLength

public int getLength()

Specified by:

getLength in interface RemoteMessage

read

public FullReadMessage<?> read()
                        throws InvalidMessageFormatException

Read the remainder of this message and returns the resulted FullReadMessage.

getBytes() will be consumed and released by this method.

Returns:

the fully read message

Throws:

InvalidMessageFormatException - if message could not be read

arm

public ArmedProtocolMessage arm(io.netty.buffer.ByteBufAllocator alloc,
 Crypto cryptoInstance,
 SessionPair sessionPair)
                         throws InvalidMessageFormatException

Returns an armed version (ArmedProtocolMessage) of this message.

Parameters:

alloc -

cryptoInstance - the crypto instance that should be used

sessionPair - will be used for encryption

Returns:

the armed version (ArmedProtocolMessage) of this message

Throws:

InvalidMessageFormatException - if arming was not possible

armAndRelease

public ArmedProtocolMessage armAndRelease(io.netty.buffer.ByteBufAllocator alloc,
 Crypto cryptoInstance,
 SessionPair sessionPair)
                                   throws InvalidMessageFormatException

Returns an armed version (ArmedProtocolMessage) of this message and then releases this message.

Parameters:

alloc -

cryptoInstance - the crypto instance that should be used

sessionPair - will be used for encryption

Returns:

the armed version (ArmedProtocolMessage) of this message

Throws:

InvalidMessageFormatException - if arming was not possible

isReadOnly

public boolean isReadOnly()

Returns true if and only if this message is read-only.

asReadOnly

public UnarmedProtocolMessage asReadOnly()

Returns a read-only version of this message.

of

public static UnarmedProtocolMessage of(HopCount hopCount,
 boolean isArmed,
 int networkId,
 Nonce nonce,
 DrasylAddress recipient,
 DrasylAddress sender,
 ProofOfWork proofOfWork,
 io.netty.buffer.ByteBuf bytes)

Creates an unarmed message.

ReferenceCounted.release() ownership of bytes is transferred to this PartialReadMessage.

Modifying the content of bytes or the returned message's buffer affects each other's content while they maintain separate indexes and marks.

Parameters:

hopCount - the hop count

isArmed - if this message is armed or not

networkId - the network id

nonce - the nonce

recipient - the public key of the recipient

sender - the public key of the sender

proofOfWork - the proof of work of sender

bytes - message's remainder as bytes (may be armed). ReferenceCounted.release() ownership is transferred to this PartialReadMessage.

Returns:

an PartialReadMessage

Throws:

NullPointerException - if nonce, sender, proofOfWork, or recipient is null