---

OCICPP::AQMessage Class Reference

Advanced Queuing uses this representation of messages. More...

List of all members.

Public Methods
	AQMessage ()
	~AQMessage ()
void	FreePayload (void)
void	getPayload (string &Payload)
void	getPayload (void **Payload, size_t *PayloadSize)
void	setPayload (string &Payload)
void	setPayload (void *Payload, size_t PayloadSize)
string	getMessageID (void)
void	setMessageID (string &MessageID)
string	getCorrelationIdentifier (void)
void	setCorrelationIdentifier (string &CorrelationIdentifier)
string	getExceptionQueue (void)
void	setExceptionQueue (string &ExceptionQueue)
int	getDelay (void)
void	setDelay (int Delay)
int	getExpiration (void)
void	setExpiration (int Expiration)
int	getPriority (void)
void	setPriority (int Priority)

---

Detailed Description

Advanced Queuing uses this representation of messages.

This class provides an encapsulation of a message used by the advanced queuing from Oracle.

A message consists out of organisatoric data (message id, priority, correlation identifier) and user data (payload).

Since the object option is not yet supported, data is stored as RAW data within the database.

---

Constructor & Destructor Documentation

OCICPP::AQMessage::AQMessage ( )

Construct a (yet to be filled) message.

OCICPP::AQMessage::~AQMessage ( )

Destroy the message and free locally allocated data.

---

Member Function Documentation

void OCICPP::AQMessage::FreePayload ( void )

Frees the payload part of the message.

string OCICPP::AQMessage::getCorrelationIdentifier ( void )

Reads the correlation identifier of the message

string OCICPP::AQMessage::getExceptionQueue ( void )

Answers the name of an exception queue

string OCICPP::AQMessage::getMessageID ( void )

Retrieves the message's id.

void OCICPP::AQMessage::getPayload ( void ** Payload, size_t * PayloadSize )

Retrieves the payload from this object as a void-pointer. The void-pointer where Payload is pointing to is initialized with a copy of the current payload and the PayloadSize is being initialized with the current size of the payload. The caller is responsible for freeing the data pointed at *Payload.

void OCICPP::AQMessage::getPayload ( string & Payload )

Retrieves the payload as string Payload.

int OCICPP::AQMessage::getPriority ( void )

Reads the priority for this message.

void OCICPP::AQMessage::setCorrelationIdentifier ( string & CorrelationIdentifier )

Sets the correlation identifier for this message

void OCICPP::AQMessage::setExceptionQueue ( string & ExceptionQueue )

Sets an exception queue for this message

void OCICPP::AQMessage::setMessageID ( string & MessageID )

Sets the message's id to MessageID.

void OCICPP::AQMessage::setPayload ( void * Payload, size_t PayloadSize )

Sets the payload to a copy of Payload (which has the size PayloadSize)

void OCICPP::AQMessage::setPayload ( string & Payload )

Set the message's payload to the string Payload.

void OCICPP::AQMessage::setPriority ( int Priority )

Sets the priority for this message.

---

The documentation for this class was generated from the following files:

• AQMessage.cpp
• AQMessage.h

---