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

All Superinterfaces:

Destination, ReceiverDestination

public interface BlockingReceiverDestination
extends ReceiverDestination

Facilitates the reception of messages while blocking the thread execution.

Since:

BlackBerry API 6.0.0

Method Summary
Message	receive() Returns a Message.
Message	receive(long timeout) Returns a Message.
Message	receiveNoWait() Returns a Message if one exists.

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

getConfig

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

destroy, getUri, pause, release, resume

Method Detail

receive

Message receive()
                throws MessagingException

Returns a Message. Blocks thread execution until a message is delivered.

Returns:

A message delivered to this destination.

Throws:

MessagingException - If this destination is not an incoming destination.

Since:

BlackBerry API 6.0.0

receive

Message receive(long timeout)
                throws MessagingException

Returns a Message. Blocks thread execution until a message is delivered, or the timeout is reached.

Parameters:

timeout - Maximum amount of time to wait for message to be delivered in milliseconds.

Returns:

Message, if one was delivered within the timeout; otherwise null.

Throws:

MessagingException - If this destination is not an incoming destination.

Since:

BlackBerry API 6.0.0

receiveNoWait

Message receiveNoWait()
                      throws MessagingException

Returns a Message if one exists. Does not block thread execution.

Returns:

A message delivered to this Destination.

Throws:

MessagingException - If this destination is not an incoming destination.

Since:

BlackBerry API 6.0.0