Consumer Class

The Consumer class supports dequeuing of Messages and controls the dequeuing options.

For typical usage, please see Example 10-5, Example 10-6 and Example 10-7.

Producer myProducer(conn);
Message m(env);

// bytes is a Bytes object representing content of the message
m.setBytes(bytes);
myProducer.send( m, "QueueNmae");

Consumer myConsumer(conn);

// Name must be registered with the queue through administrative interface
myConsumer.setConsumerName("ConsumerOne");
Message m = myConsumer.receive(Message::RAW);
Bytes b = m.getBytes();

Consumer myConsumer(conn);
...
myConsumer.setAgent(ag);
myConsumer.receive();

DEQ_BROWSE

DEQ_LOCKED

DEQ_REMOVE

DEQ_NO_DATA

DEQ_FIRST_MSG

DEQ_NEXT_MSG

DEQ_NEXT_TRANSACTION

DEQ_ON_COMMIT

DEQ_IMMEDIATE

DEQ_NO_WAIT

DEQ_WAIT_FOREVER

Consumer()

Consumer class constructor.

Consumer(
   Connection *conn);

Consumer(
   Connection *conn
   Agent agent);

Consumer(
   Connection *conn,
   const string& queue);

conn

queue

getConsumerName()

Retrieve the name of the Consumer.

string getConsumerName() const;

getCorrelationId()

Retrieve she correlation id of the message that is to be dequeued

string geCorrelationId() const;

getDequeueMode()

Retrieve the dequeue mode of the Consumer. These valid values for the dequeue mode are defined as constants of the Consumer class in Table 10-11: DEQ_BROWSE, DEQ_LOCKED, DEQ_REMOVE and DEQ_REMOVE_NODATA.

DequeueMode getDequeueMode() const;

getMessageIdToDequeue()

Retrieves the id of the message that will be dequeued.

Bytes getMessageToDequeue() const;

getPositionOfMessage()

Retrieves the position of the message that will be dequeued. These valid values for the position of the message are defined as constants of the Consumer class in Table 10-11: DEQ_FIRST_MSG, DEQ_NEXT_MSG and DEQ_NEXT_TRANSACTION.

Navigation getPositionOfMessage() const;

getQueueName()

Gets the name of the queue used by the consumer.

string getQueueName() const;

getTransformation()

Retrieves the transformation applied before a Message is dequeued.

string getTransformation() const;

getVisibility()

Retrieves the transactional behavior of the dequeue operation. These valid values for visibility are defined as constants of the Consumer class in Table 10-11: DEQ_ON_COMMIT and DEQ_IMMEDIATE.

Visibility getVisibility() const;

getWaitTime()

Retrieve the specified behavior of the Consumer when waiting for a Message with matching search criteria. These valid values for visibility are defined as constants of the Consumer class in Table 10-11: DEQ_WAIT_FOREVER and DEQ_NO_WAIT.

unsigned int getWaitTime() const;

isNull()

Tests whether the Consumer object is NULL. If the Consumer object is NULL, TRUE is returned; otherwise, FALSE is returned.

bool isNull() const;

receive()

Receives and dequeue a Message.

Message receive(
   Message::PayloadType pType,
   const string& type="",
   const string& schema="");

pType

enum PayloadType {RAW, ANYDATA, OBJECT};

type

schema

setAgent()

Sets the Agent's name and address (queue name) on the consumer.

void setAgent(
   const Agent& agent);

agent

setConsumerName()

Sets the Consumer name. Only messages with matching consumer name can be accessed. If a queue is not set up for multiple consumer, this option should be set to NULL.

void setConsumerName(
   const string& name);

name

setCorrelationId()

Specify the correlation identifier of the message to be dequeued. Special pattern matching characters, such as the percent sign (%) and the underscore(_) can be used. If several messages satisfy the pattern, the order of dequeuing is undetermined.

void setCorrelationId
   const string& id);

id

setDequeueMode()

Specify the locking behavior associated with dequeuing.

void setDequeueMode(
   DequeueMode deqMode);

deqMode

setMessageIdToDequeue()

Specifies the identifier of the Message to be dequeued.

void setMessageIdToDequeue(
   const Bytes& id);

id

setNull()

Nullifies the Consumer; frees the memory associated with this object.

void setNull();

setPositionOfMessage()

Specifies position of the Message to be retrieved.

void setPositionOfMessage(
   Navigation nav);

nav

setQueueName()

Specifies the name of a queue prior to dequeuing Messages. Typically used when dequeuing multiple messages from the same queue.

void setQueueName(
   const string& queueName);

queueName

setTransformation()

Specifies transformation applied before dequeuing the Message.

void setTransformation(
   string &transFunction);

transFunction

setVisibility()

Specifies if Message should be dequeued as part of the current transaction. Visibility parameter is ignored when in DEQ_BROWSE mode.

void setVisibility(
   Visibility vis);

vis

setWaitTime()

Specify wait conditions if there are no Messages with matching criteria. The waitTime parameter is ignored if messages in the same group are being dequeued.

void setWaitTime(
   unsigned int waitTime);

vwaitTime