Called when the underlying implementation has received an indication
that a message, sent earlier has been successfully received by the
destination. The method returns an instance of
MessageDeliveredEvent which in many cases would be different
from the evt instance that was passed as a parameter. The param
and the return instances could very well (and will often) be instances of
different implementations so users of this interface (i.e. protocol
implementors) should make no assumptions for the class of the return type
and copy the returned instance into a new one if necessary.
evt - the MessageDeliveredEvent containing the id of the message
that has caused the event.
Returns:
an instance of a (possibly new) MessageDeliveredEvent
instance containing the transformed message or null if the
TransportLayer has determined that this message event should not
be delivered to the upper layers.
Called to indicated that delivery of a message sent earlier has failed.
Reason code and phrase are contained by the MessageFailedEvent
The method returns an instance of
MessageDeliveredEvent which in many cases would be different
from the evt instance that was passed as a parameter. The param
and the return instances could very well (and will often) be instances of
different implementations so users of this interface (i.e. protocol
implementors) should make no assumptions for the class of the return type
and copy the returned instance into a new one if necessary.
evt - the MessageFailedEvent containing the ID of the
message whose delivery has failed.
Returns:
an instance of a (possibly new) MessageDeliveredEvent
instance containing the transformed message or null if the
TransportLayer has determined that this message event should not
be delivered to the upper layers.
Called when the underlying implementation has just been asked by other
bundles to send an outgoing message. The method returns an instance of
MessageDeliveredEvent which in many cases would be different
from the evt instance that was passed as a parameter. The param
and the return instances could very well (and will often) be instances of
different implementations so users of this interface (i.e. protocol
implementors) should make no assumptions for the class of the return type
and copy the returned instance into a new one if necessary.
evt - the MessageDeliveredEvent containing the id of the message
that has caused the event.
Returns:
a number of instances of (possibly new)
MessageDeliveredEvent instances containing the transformed
message(s) or an empty array if the TransportLayer has
determined that there are no message event that should be delivered to
the upper layers.
Called when a new incoming Message has been received. The method
returns an instance of MessageReceivedEvent which in many cases
would be different from the evt instance that was passed as
param. The param and the return instances could very well (and will
often) be instances of different implementations so users of this
interface (i.e. protocol implementors) should make no assumptions
for the class of the return type and copy the returned instance into
a new one if necessary.
evt - the MessageReceivedEvent containing the newly
received message, its sender and other details.
Returns:
an instance of a (possibly new) MessageReceivedEvent
instance containing the transformed message or null if the
TransportLayer has determined that this message event should not
be delivered to the upper layers.