net.maritimecloud.net

Interface MessageHeader

public interface MessageHeader

The header of a received message.

Author:

Kasper Nielsen

Method Summary

Modifier and Type	Method and Description
default Map<String,Object>	context() Implementations might choose to provide additional properties to consumers of messages.
Binary	getMessageId() Returns a unique id of the transmitted message.
MaritimeId	getSender() Returns the identity of the party that send the message.
Position	getSenderPosition() If the sending party has a position, returns said position.
Timestamp	getSenderTime() Returns the timestamp of the message.

Method Detail

context

default Map<String,Object> context()

Implementations might choose to provide additional properties to consumers of messages.

Returns:

a map containing additional properties about the message.

getMessageId

Binary getMessageId()

Returns a unique id of the transmitted message.

This hash is calculated as a combination of the name of the remote actor who sent the message. The position and time of the actor who sent the message. The name of the broadcast type. And the actual binary contents of the broadcast message.

Returns:

a unique hash for the specified message

getSender

MaritimeId getSender()

Returns the identity of the party that send the message.

Returns:

the identity of the party that send the message

getSenderPosition

Position getSenderPosition()

If the sending party has a position, returns said position. Otherwise returns null.

Returns:

if the sending party has a position, returns said position

getSenderTime

Timestamp getSenderTime()

Returns the timestamp of the message.

Returns:

the timestamp of the message