net.rim.device.api.io.messaging
Interface SenderDestination

All Superinterfaces:

Destination

All Known Subinterfaces:

BlockingSenderDestination, FireAndForgetDestination, NonBlockingSenderDestination

public interface SenderDestination
extends Destination

Contains methods for the creation and cancellation of the outgoing messages. See Destination for more information.

Since:

BlackBerry API 6.0.0

Method Summary
void	cancel(int messageId) Attempts to cancel the transmission of a message, if possible.
void	cancelAllCancellable() Attempts to cancel all queued messages.
ByteMessage	createByteMessage() Creates a new ByteMessage used by this Destination.
StreamMessage	createStreamMessage() Creates a new StreamMessage for this Destination.

Methods inherited from interface net.rim.device.api.io.messaging.Destination

destroy, getUri, pause, release, resume

Method Detail

createByteMessage

ByteMessage createByteMessage()

Creates a new ByteMessage used by this Destination.

Returns:

A new, empty ByteMessage of for this Destination.

Since:

BlackBerry API 6.0.0

createStreamMessage

StreamMessage createStreamMessage()

Creates a new StreamMessage for this Destination.

Returns:

A new, empty StreamMessage for this Destination

Since:

BlackBerry API 6.0.0

cancel

void cancel(int messageId)
            throws MessagingException

Attempts to cancel the transmission of a message, if possible.

Parameters:

messageId - The ID of the message to cancel.

Throws:

MessagingException - The exception is thrown if invalid message ID is passed as a parameter

Since:

BlackBerry API 6.0.0

cancelAllCancellable

void cancelAllCancellable()

Attempts to cancel all queued messages.

Since:

BlackBerry API 6.0.0