com.hcl.domino.mq

Interface MessageQueue

All Superinterfaces:

AutoCloseable, BlockingQueue<String>, Closeable, Collection<String>, Iterable<String>, Queue<String>

public interface MessageQueue
extends BlockingQueue<String>, Closeable

Implementation note: due to the underlying MQ capabilities, this implementation of BlockingQueue is not expected to implement the following methods:

• containsAll
• element
• peek
• removeAll
• retainAll
• contains
• remove

Author:

t.b.d

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageQueue.IMQCallback Callback interface to scan a message queue for new messages

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_MESSAGE_COUNT Maximum allowed message-count per queue.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getName() Returns the name of the queue as specified via MessageQueues.createAndOpen(String, int) or MessageQueues.open(String, boolean) respectively.
boolean	isQuitPending() This function tests whether the specified message queue is in a QUIT state, and returns TRUE if so.
void	put(byte[] buffer, int priority, int offset, int length) This function adds a message to the message queue. The message will be placed in the queue according to the value of its priority argument - higher priority messages will be enqueued ahead of lower priority messages. If the queue is full or in a QUIT state, the message will not be put in the queue, and the function will return an appropriate error code.
void	putQuitMsg() This function puts the message queue in a QUIT state, which indicates to applications that read the message queue that they should terminate.
int	scan(byte[] buffer, MessageQueue.IMQCallback callback) This function parses a message queue, calling an action routine for each message in the queue. If the message queue is empty, or if all messages in the queue have been enumerated without returning an error code, MQScan returns ERR_MQ_EMPTY. In the simple case, MQScan() does not modify the contents of the queue; by returning the appropriate error codes to MQScan, the action routine can specify that messages are to be removed from the queue or skipped, or that enumeration is to be terminated immediately.

Methods inherited from interface java.util.concurrent.BlockingQueue

add, contains, drainTo, drainTo, offer, offer, poll, put, remainingCapacity, remove, take

Methods inherited from interface java.util.Queue

element, peek, poll, remove

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

MAX_MESSAGE_COUNT

static final int MAX_MESSAGE_COUNT

Maximum allowed message-count per queue. TODO: verify if this is actually the case

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of the queue as specified via MessageQueues.createAndOpen(String, int) or MessageQueues.open(String, boolean) respectively.

Returns:

the name of the queue

scan

int scan(byte[] buffer,
         MessageQueue.IMQCallback callback)

This function parses a message queue, calling an action routine for each message in the queue.
If the message queue is empty, or if all messages in the queue have been enumerated without returning an error code, MQScan returns ERR_MQ_EMPTY.

In the simple case, MQScan() does not modify the contents of the queue; by returning the appropriate error codes to MQScan, the action routine can specify that messages are to be removed from the queue or skipped, or that enumeration is to be terminated immediately. See the reference entry for MessageQueue.IMQCallback for more details.

Note: MQScan locks out all other message queue function calls until it completes.

Parameters:

buffer - buffer to be used to read messages, max size is 65326 bytes

callback - callback to be called for each message; if null, we dequeue the a message and return it in the specified buffer

Returns:

The number of bytes written to the buffer (important if callback has been set to null)

putQuitMsg

void putQuitMsg()

This function puts the message queue in a QUIT state, which indicates to applications that read the message queue that they should terminate.

put

void put(byte[] buffer,
         int priority,
         int offset,
         int length)

This function adds a message to the message queue.
The message will be placed in the queue according to the value of its priority argument - higher priority messages will be enqueued ahead of lower priority messages.

If the queue is full or in a QUIT state, the message will not be put in the queue, and the function will return an appropriate error code.

Parameters:

buffer - buffer containing the message. Maximum buffer length is 65326 bytes

priority - priority

offset - offset in the buffer where the message starts

length - lengths of the message in the buffer

isQuitPending

boolean isQuitPending()

This function tests whether the specified message queue is in a QUIT state, and returns TRUE if so. Otherwise, it returns FALSE.

Returns:

true if in quite state

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable