net.maritimecloud.net

Interface DispatchedMessage

All Known Subinterfaces:

EndpointInvocationFuture<T>

public interface DispatchedMessage

A dispatched message is returned when sending a message asynchronously.

Author:

Kasper Nielsen

Method Summary

Modifier and Type	Method and Description
Binary	getMessageId() Returns a unique id of the message that was send.
Position	getPosition() Returns any position that was attached to the message being sent.
Timestamp	getTime() Returns the time stamp that was attached to the message being sent.
Acknowledgement	relayed() If the underlying protocol used for sending the message uses a central relaying server, for example MMS.

Method Detail

getMessageId

Binary getMessageId()

Returns a unique id of the message that was send.

Returns:

a unique id of the message that was send

getPosition

Position getPosition()

Returns any position that was attached to the message being sent. Clients that do not have a position reader attached will not attach a position to the header of the message and returns null.

Returns:

any position that was attached to the message being sent

getTime

Timestamp getTime()

Returns the time stamp that was attached to the message being sent.

Returns:

the time stamp that was attached to the message being sent

relayed

Acknowledgement relayed()

If the underlying protocol used for sending the message uses a central relaying server, for example MMS. This method can be used to determine when the message have been received by the MMS server. This is done on a best effort basis. The message might, but rarely does, be delivered to remote clients before the returned future completes.

Returns:

an acknowledgement object that can be used to execute actions when the message has been delivered to a relay server

Throws:

UnsupportedOperationException - if the underlying communication mechanism does not make of a central relaying server.