com.solacesystems.jcsmp

Interface Consumer

All Known Subinterfaces:

DestinationConsumer, FlowReceiver, XMLMessageConsumer

All Known Implementing Classes:

DirectFlowHandleImpl, FlowHandleImpl, JCSMPXMLMessageConsumer, TopicConsumerImpl

@ProviderType
public interface Consumer

Consumer objects are used to receive messages from the Solace Messaging Platform.

Note: Applications must cache this instance, and close it only when it is no longer required.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the message consumer, rendering it unusable.
void	closeSync()
void	closeSync(boolean linger)
BytesXMLMessage	receive() Receives the next available message, waiting until one is available.
BytesXMLMessage	receive(int timeoutInMillis) Receives the next available message.
BytesXMLMessage	receiveNoWait() Receives the next available message.
void	start() Enables receiving messages from an appliance.
void	startSync()
void	stop() Disables receiving messages from an appliance.
void	stopSync()
boolean	stopSyncStart()
void	stopSyncWait()

Method Detail

closeSync

void closeSync()
        throws JCSMPException

Throws:

JCSMPException

closeSync

void closeSync(boolean linger)
        throws JCSMPException

Throws:

JCSMPException

close

void close()

Closes the message consumer, rendering it unusable.

Once closed, an application acquires a new instance in order to continue to receive messages.

New messages will not be processed and delivered after a call to close() returns, although it is possible for a single asynchronous message delivery to occur if it has already begun when close() is called.

startSync

void startSync()
        throws JCSMPException

Throws:

JCSMPException - on error

start

void start()
    throws JCSMPException

Enables receiving messages from an appliance.

Throws:

JCSMPException - upon error

InvalidOperationException - when called on a closed consumer.

stop

void stop()

Disables receiving messages from an appliance.

Note that there is no guarantee the effect of calling stop() will be instantaneous: messages already in-flight or being processed by the API may still be delivered after the call to stop() returns.

stopSync

void stopSync()
       throws JCSMPInterruptedException

Throws:

JCSMPInterruptedException

stopSyncStart

boolean stopSyncStart()

stopSyncWait

void stopSyncWait()
           throws JCSMPInterruptedException

Throws:

JCSMPInterruptedException

receive

BytesXMLMessage receive()
                 throws JCSMPException

Receives the next available message, waiting until one is available.

Returns:

The next available message, or null if it is interrupted.

Throws:

InvalidOperationException - If the consumer is not started, or a message listener is set.

JCSMPTransportException - If the consumer was closed after the function was called, but before any message was received.

JCSMPException

receive

BytesXMLMessage receive(int timeoutInMillis)
                 throws JCSMPException

Receives the next available message. If no message is available, this method blocks until timeoutInMillis is reached. A timeout of zero never expires, and the call blocks indefinitely.

Parameters:

timeoutInMillis - The timeout in milliseconds.

Returns:

The next available message, or null if the timeout expires.

Throws:

InvalidOperationException - If the consumer is not started, or a message listener is set.

JCSMPTransportException - If the consumer was closed after the method was called, but before any message was received.

JCSMPException

receiveNoWait

BytesXMLMessage receiveNoWait()
                       throws JCSMPException

Receives the next available message. If no message is available, this method returns null immediately.

Returns:

The next available message, or null if one is not available.

Throws:

InvalidOperationException - If the consumer is not started, or a message listener is set.

JCSMPTransportException - If the consumer was closed after the function was called but before any message was received.

JCSMPException