eu.hgross.blaubot.core.acceptor.discovery

Class BeaconMessage

java.lang.Object

eu.hgross.blaubot.core.acceptor.discovery.BeaconMessage

All Implemented Interfaces:

java.io.Serializable

public class BeaconMessage
extends java.lang.Object
implements java.io.Serializable

Represents a message exchanged when two devices connect via the beacon interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BeaconMessage(java.lang.String ownUniqueDeviceId, State currentState, java.util.List<ConnectionMetaDataDTO> ownConnectionMetaDataList) Constructor for the beacon message in cases where we have no king or we are the king
BeaconMessage(java.lang.String ownUniqueDeviceId, State currentState, java.util.List<ConnectionMetaDataDTO> ownConnectionMetaDataList, java.lang.String kingDeviceId, java.util.List<ConnectionMetaDataDTO> kingsConnectionMetaDataList) Constructor for the beacon message in case we are a subordinate to a king and therefore have a connection to a king

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static BeaconMessage	fromBlaubotConnection(IBlaubotConnection connection) Create the message from the stream of a blaubot connection.
static BeaconMessage	fromBytes(byte[] bytes)
State	getCurrentState()
java.lang.String	getKingDeviceUniqueId() Note: is only set if currentState is State.Prince or State.Peasant
java.util.List<ConnectionMetaDataDTO>	getKingsConnectionMetaDataList() The acceptor meta data for the device's for which we received the state
java.util.List<ConnectionMetaDataDTO>	getOwnConnectionMetaDataList() The acceptor meta data for the device for which we received the state
java.lang.String	getUniqueDeviceId() Getter for the unique device id of the sending side
int	hashCode()
static void	main(java.lang.String[] args)
void	setCurrentState(State currentState)
byte[]	toBytes() Get the byte representation of this message
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BeaconMessage

public BeaconMessage(java.lang.String ownUniqueDeviceId,
                     State currentState,
                     java.util.List<ConnectionMetaDataDTO> ownConnectionMetaDataList)

Constructor for the beacon message in cases where we have no king or we are the king

Parameters:

ownUniqueDeviceId - the unique device id of the sending side's ownDevice

currentState - our device's current state

ownConnectionMetaDataList - our own connection meta data list of our acceptors

BeaconMessage

public BeaconMessage(java.lang.String ownUniqueDeviceId,
                     State currentState,
                     java.util.List<ConnectionMetaDataDTO> ownConnectionMetaDataList,
                     java.lang.String kingDeviceId,
                     java.util.List<ConnectionMetaDataDTO> kingsConnectionMetaDataList)

Constructor for the beacon message in case we are a subordinate to a king and therefore have a connection to a king

Parameters:

ownUniqueDeviceId - the unique device id of the sending side's ownDevice

currentState - our device's current state

ownConnectionMetaDataList - our own connection meta data list of our acceptors

kingDeviceId - the king's uniqueDevice id

kingsConnectionMetaDataList - the king's connection meta data list to propagate to other interested device

Method Detail

getCurrentState

public State getCurrentState()

setCurrentState

public void setCurrentState(State currentState)

toBytes

public byte[] toBytes()

Get the byte representation of this message

Returns:

the byte array containing the message in the byte order of BlaubotConstants.STRING_CHARSET

fromBytes

public static BeaconMessage fromBytes(byte[] bytes)

fromBlaubotConnection

public static BeaconMessage fromBlaubotConnection(IBlaubotConnection connection)

Create the message from the stream of a blaubot connection. Note: The connection will be closed via disconnect() on IO errors.

Parameters:

connection - the connection to receive the message from

Returns:

message or null, if smthg went wrong

getUniqueDeviceId

public java.lang.String getUniqueDeviceId()

Getter for the unique device id of the sending side

Returns:

the unique id

getKingDeviceUniqueId

public java.lang.String getKingDeviceUniqueId()

Note: is only set if currentState is State.Prince or State.Peasant

Returns:

the king's uniqueDeviceId or null, if currentState not in (State.Prince, State.Peasant)

getOwnConnectionMetaDataList

public java.util.List<ConnectionMetaDataDTO> getOwnConnectionMetaDataList()

The acceptor meta data for the device for which we received the state

Returns:

the meta data for the remote device's acceptors

getKingsConnectionMetaDataList

public java.util.List<ConnectionMetaDataDTO> getKingsConnectionMetaDataList()

The acceptor meta data for the device's for which we received the state

Returns:

the remote device's king's acceptor meta data or null, if it has no king

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object