com.solacesystems.jcsmp

Interface FlowReceiver

All Superinterfaces:

Consumer

All Known Implementing Classes:

DirectFlowHandleImpl, FlowHandleImpl

public interface FlowReceiver
extends Consumer

An interface for applications to receive messages from an Endpoint on a Solace appliance. All messages delivered to a Session through a particular appliance Endpoint are transmitted on a logical flow.

FlowReceiver is acquired from JCSMPSession. When acquired successfully, an instance of FlowReceiver has a channel (connection) opened to the appliance, which is shared with other FlowReceiver instances within the same Session. In general, it is an expensive operation to acquire a FlowReceiver instance. Applications must cache this instance, and close it only when it is no longer needed.

Note: The methods defined in this interface are non-thread-safe, except the start, stop and close() methods, which be can called at any time by any thread.

Lifecycle Concerns

To receive messages, an application must call start() to start receiving messages from the underlying connection by using either synchronous receive(...) calls or using asynchronous notification by setting XMLMessageListener. The received messages are read-only.

The stop() method is used to disable the receiving of messages on this flow.

Once the close() method is invoked, any further access causes an exception to be thrown.

A flow can be administratively closed on the appliance, or closed due to an error condition. Such an event is indicated by throwing on access (or, in the case of a flow in asynchronous mode, delivering to the XMLMessageListener) a JCSMPFlowTransportException.

Method Summary

Modifier and Type	Method and Description
void	close(boolean linger) [SolReserved] Close a flow, optionally signaling a non-durable Endpoint should linger on the appliance.
Destination	getDestination() Returns the Destination to which messages should be published to get routed to this flow's bound Endpoint.
Endpoint	getEndpoint() Returns the appliance Endpoint this flow is bound to.
Subscription	getSubscription() Returns the subscription associated to the Endpoint when bound to a TopicEndpoint.
void	logFlowInfo(JCSMPLogLevel level) Outputs a log containing the flow state information for the flow at a specified log level.
void	setMessageListener(XMLMessageListener listener)

Methods inherited from interface com.solacesystems.jcsmp.Consumer

close, closeSync, closeSync, receive, receive, receiveNoWait, start, startSync, stop, stopSync, stopSyncStart, stopSyncWait

Method Detail

setMessageListener

void setMessageListener(XMLMessageListener listener)

close

void close(boolean linger)

[SolReserved] Close a flow, optionally signaling a non-durable Endpoint should linger on the appliance. When linger is set, the Endpoint will not be destroyed immediately, but rather only after a appliance-defined timeout. Unacknowledged messages on the Endpoint will be preserved during this time.

Parameters:

linger - If true, and this flow is bound to a non-durable Endpoint, signals to the appliance the Endpoint should not be immediately destroyed.

logFlowInfo

void logFlowInfo(JCSMPLogLevel level)

Outputs a log containing the flow state information for the flow at a specified log level.

Parameters:

level - The level (corresponding to org.apache.commons.logging levels) at which to output the log.

getEndpoint

Endpoint getEndpoint()

Returns the appliance Endpoint this flow is bound to.

Returns:

The bound appliance Endpoint.

getSubscription

Subscription getSubscription()

Returns the subscription associated to the Endpoint when bound to a TopicEndpoint.

Returns:

The Topic subscription associated to the TopicEndpoint this flow is bound to, null if not bound to a TopicEndpoint.

getDestination

Destination getDestination()

Returns the Destination to which messages should be published to get routed to this flow's bound Endpoint.

• If bound to a TopicEndpoint, the Destination will be of type Topic.
• If bound to a Queue, the Destination will be of type Queue.
• If bound to a SubscriberEndpoint, this method returns null.

Returns:

The Destination to which messages should be published to get routed to this flow's bound Endpoint.