com.bloomberg.bmq

Interface Queue

public interface Queue

SDK Queue representation.

Method Summary

Modifier and Type	Method and Description
void	close(Duration timeout) Closes the queue synchronously.
void	closeAsync(Duration timeout) Closes the queue asynchronously.
void	configure(QueueOptions options, Duration timeout) Configures the queue synchronously.
void	configureAsync(QueueOptions options, Duration timeout) Opens the queue asynchronously.
PutMessage	createPutMessage(ByteBuffer... payload) Creates a PUT message object bounded to this queue with the specified payload
void	flush() Sends previously packed PUT messages in one multi message PUT event.
boolean	isOpen() Checks if the queue is opened.
void	open(QueueOptions options, Duration timeout) Opens the queue synchronously.
void	openAsync(QueueOptions options, Duration timeout) Opens the queue asynchronously.
void	pack(PutMessage message) Adds a single PUT message to be sent withing multi message PUT event.
void	post(PutMessage message) Sends a single PUT message to this queue.
Uri	uri() Gets queue URI.

Method Detail

open

void open(QueueOptions options,
          Duration timeout)

Opens the queue synchronously.

This operation will block until either success, failure, or timing out happens.

Parameters:

options - the options to configure some advanced settings.

timeout - the operation timeout.

Throws:

BMQException - in case of failure.

See Also:

QueueOptions

openAsync

void openAsync(QueueOptions options,
               Duration timeout)

Opens the queue asynchronously.

This operation will post open queue request and return immediately. Success, failure, or timing out will be reported through QueueEventHandler

Parameters:

options - the options to configure some advanced settings

timeout - the operation timeout

Throws:

BMQException - in case of failure

See Also:

QueueOptions

configure

void configure(QueueOptions options,
               Duration timeout)

Configures the queue synchronously.

Fields from 'options' that have not been explicitly set will not be modified.

This operation will block until either success, failure, or timing out happens.

Parameters:

options - options to configure some advanced settings

timeout - operation timeout

Throws:

BMQException - in case of failure

See Also:

QueueOptions

configureAsync

void configureAsync(QueueOptions options,
                    Duration timeout)

Opens the queue asynchronously.

Fields from 'options' that have not been explicitly set will not be modified.

This operation will post configure queue request and return immediately. Success, failure, or timing out will be reported through QueueEventHandler

Parameters:

options - options to configure some advanced settings

timeout - operation timeout

Throws:

BMQException - in case of failure

See Also:

QueueOptions

close

void close(Duration timeout)

Closes the queue synchronously.

This operation will block until either success, failure, or timing out happens.

Parameters:

timeout - operation timeout

Throws:

BMQException - in case of failure

closeAsync

void closeAsync(Duration timeout)

Closes the queue asynchronously.

This operation will post close queue request and return immediately. Success, failure, or timing out will be reported through QueueEventHandler

Parameters:

timeout - operation timeout

Throws:

BMQException - in case of failure

createPutMessage

PutMessage createPutMessage(ByteBuffer... payload)

Creates a PUT message object bounded to this queue with the specified payload

Parameters:

payload - this message payload

Returns:

PutMessage that can be sent via this queue

Throws:

BMQException - in case of failure while setting the payload

RuntimeException - in case of other failures

post

void post(PutMessage message)

Sends a single PUT message to this queue.

Parameters:

message - PUT message to be sent

Throws:

BMQException - in case of failure

pack

void pack(PutMessage message)

Adds a single PUT message to be sent withing multi message PUT event.

Parameters:

message - PUT message to add

Throws:

BMQException - in case of failure

flush

void flush()

Sends previously packed PUT messages in one multi message PUT event.

Throws:

BMQException - in case of failure

uri

Uri uri()

Gets queue URI.

Returns:

Uri of this queue

isOpen

boolean isOpen()

Checks if the queue is opened.

Returns:

true if the queue is opened, otherwise false