Package org.drasyl.peer.connection.message

Class QuitMessage

java.lang.Object

org.drasyl.peer.connection.message.QuitMessage

All Implemented Interfaces:

Message, RequestMessage

public class QuitMessage
extends Object
implements RequestMessage

A message representing a termination of a connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QuitMessage.CloseReason	Specifies the reason for closing the connection.

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<String>	defaultUserAgentGenerator
protected short	hopCount
protected final MessageId	id
protected final int	networkId
protected final ProofOfWork	proofOfWork
protected final CompressedPublicKey	recipient
protected final CompressedPublicKey	sender
protected final String	userAgent
static Supplier<String>	userAgentGenerator

Constructor Summary

Constructors

Constructor	Description
QuitMessage(int networkId, CompressedPublicKey sender, ProofOfWork proofOfWork, CompressedPublicKey recipient, QuitMessage.CloseReason reason)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
short	getHopCount()	Returns this message's hop count.
MessageId	getId()	Returns the unique id of this message.
int	getNetworkId()	Returns the network the sender belongs to.
ProofOfWork	getProofOfWork()	Returns this message sender's proof of work.
QuitMessage.CloseReason	getReason()
CompressedPublicKey	getRecipient()	Returns this message's recipient.
CompressedPublicKey	getSender()	Returns this message's sender.
String	getUserAgent()	Returns the user agent of the sender's node.
int	hashCode()
void	incrementHopCount()	Increases the message's hop count.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.drasyl.peer.connection.message.Message

getHopCount, getId, getNetworkId, getProofOfWork, getRecipient, getSender, getUserAgent, incrementHopCount

Field Details

defaultUserAgentGenerator

public static final Supplier<String> defaultUserAgentGenerator

userAgentGenerator

public static Supplier<String> userAgentGenerator

id

protected final MessageId id

userAgent

protected final String userAgent

networkId

protected final int networkId

sender

protected final CompressedPublicKey sender

proofOfWork

protected final ProofOfWork proofOfWork

recipient

protected final CompressedPublicKey recipient

hopCount

protected short hopCount

Constructor Details

QuitMessage

public QuitMessage(int networkId,
 CompressedPublicKey sender,
 ProofOfWork proofOfWork,
 CompressedPublicKey recipient,
 QuitMessage.CloseReason reason)

Method Details

hashCode

public int hashCode()

equals

public boolean equals(Object o)

toString

public String toString()

Overrides:

toString in class Object

getReason

public QuitMessage.CloseReason getReason()

getId

public MessageId getId()

Description copied from interface: Message

Returns the unique id of this message. Each message generates a random id when it is created.

Specified by:

getId in interface Message

Returns:

the unique id of this message. Each message generates a random id when it is created.

getUserAgent

public String getUserAgent()

Description copied from interface: Message

Returns the user agent of the sender's node.

Specified by:

getUserAgent in interface Message

Returns:

the user agent of the sender's node.

getNetworkId

public int getNetworkId()

Description copied from interface: Message

Returns the network the sender belongs to.

Specified by:

getNetworkId in interface Message

Returns:

the network the sender belongs to

getSender

public CompressedPublicKey getSender()

Description copied from interface: Message

Returns this message's sender.

Specified by:

getSender in interface Message

Returns:

this message's sender.

getProofOfWork

public ProofOfWork getProofOfWork()

Description copied from interface: Message

Returns this message sender's proof of work.

Specified by:

getProofOfWork in interface Message

Returns:

this message sender's proof of work.

getRecipient

public CompressedPublicKey getRecipient()

Description copied from interface: Message

Returns this message's recipient.

Specified by:

getRecipient in interface Message

Returns:

this message's recipient.

getHopCount

public short getHopCount()

Description copied from interface: Message

Returns this message's hop count. Starts at 0 and is incremented every time it is sent. Once the message reaches the limit defined in config drasyl.message.hop-limit it will be dropped.

Specified by:

getHopCount in interface Message

Returns:

this message's hop count.

incrementHopCount

public void incrementHopCount()

Description copied from interface: Message

Increases the message's hop count.

Specified by:

incrementHopCount in interface Message