com.bloomberg.bmq

Interface AbstractSession

All Known Implementing Classes:

Session

public interface AbstractSession

Interface to the Session that provides access to the BlazingMQ broker

Method Summary

Modifier and Type	Method and Description
Queue	getQueue(Uri uri, long flags, QueueEventHandler handler, AckMessageHandler ackHandler, PushMessageHandler pushHandler) Create a queue representation.
boolean	isStarted() Check if the 'Session' is started
void	linger() Shutdown all connection and event handling threads.
void	start(Duration timeout) Connect to the BlazingMQ broker and start the message processing
void	startAsync(Duration timeout) Connect to the BlazingMQ broker and start the message processing
void	stop(Duration timeout) Gracefully disconnect from the BlazingMQ broker and stop the operation of this 'Session'.
void	stopAsync(Duration timeout) Gracefully disconnect from the BlazingMQ broker and stop the operation of this 'Session'.

Method Detail

start

void start(Duration timeout)

Connect to the BlazingMQ broker and start the message processing

This method blocks until either the 'Session' is connected to the broker, fails to connect, or the operation times out.

Parameters:

timeout - start timeout value

Throws:

BMQException - if start attempt failed

startAsync

void startAsync(Duration timeout)

Connect to the BlazingMQ broker and start the message processing

This method returns without blocking. The result of the operation is communicated with a session event. If the optionally specified 'timeout' is not populated, use the one defined in the session options.

Parameters:

timeout - start timeout value

Throws:

BMQException - in case of failure

isStarted

boolean isStarted()

Check if the 'Session' is started

Returns:

true if the 'Session' is started, otherwise false

stop

void stop(Duration timeout)

Gracefully disconnect from the BlazingMQ broker and stop the operation of this 'Session'.

This method blocks waiting for all already invoked event handlers to exit and all session-related operations to be finished.

Parameters:

timeout - stop timeout value

Throws:

BMQException - if stop attempt failed

stopAsync

void stopAsync(Duration timeout)

Gracefully disconnect from the BlazingMQ broker and stop the operation of this 'Session'.

This method returns without blocking. The result of the operation is communicated with a session event. If the optionally specified 'timeout' is not populated, use the one defined in the session options.

Parameters:

timeout - stop timeout value

Throws:

BMQException - in case of failure

linger

void linger()

Shutdown all connection and event handling threads.

This method must be called when the Session is stopped. No other method may be used after this method returns.

getQueue

Queue getQueue(Uri uri,
               long flags,
               QueueEventHandler handler,
               AckMessageHandler ackHandler,
               PushMessageHandler pushHandler)

Create a queue representation.

Returned Queue may be in any state.

Parameters:

uri - URI of the created Queue, immutable

flags - a combination of the values defined in QueueFlags

handler - queue event handler callback interface

ackHandler - callback handler for incoming ACK events, can be null if only consumer

pushHandler - callback handler for incoming PUSH events, can be null if only producer

Returns:

Queue interface to the queue instance

Throws:

IllegalArgumentException - in case of a wrong combination of the queue flags and the handlers

BMQException - for any other unrecoverable errors

See Also:

QueueFlags