OCILIB (C and C++ Driver for Oracle)
4.1.0
|
Enqueue object for queuing messages into an Oracle Queue. More...
#include <ocilib.hpp>
Inherits ocilib::HandleHolder< OCI_Enqueue * >.
Public Types | |
enum | EnqueueModeValues { Before = OCI_ASD_BEFORE, OnTop = OCI_ASD_TOP } |
Message enqueuing mode enumerated values. More... | |
enum | EnqueueVisibilityValues { Immediate = OCI_AMV_IMMEDIATE, OnCommit = OCI_AMV_ON_COMMIT } |
Message visibility enumerated values. More... | |
typedef Enum< EnqueueModeValues > | EnqueueMode |
Message enqueuing mode. More... | |
typedef Enum < EnqueueVisibilityValues > | EnqueueVisibility |
Message visibility after begin queued. More... | |
Public Member Functions | |
Enqueue (const TypeInfo &typeInfo, const ostring &queueName) | |
Create a Enqueue object for the given queue. More... | |
void | Put (const Message &message) |
Enqueue a message the on queue associated to the Enqueue object. More... | |
EnqueueVisibility | GetVisibility () const |
Get the enqueuing/locking behavior. More... | |
void | SetVisibility (EnqueueVisibility value) |
Set whether the new message is enqueued as part of the current transaction. More... | |
EnqueueMode | GetMode () const |
Return the enqueuing mode of messages to enqueue. More... | |
void | SetMode (EnqueueMode value) |
Set the enqueuing mode of messages to put in the queue. More... | |
Raw | GetRelativeMsgID () const |
Get the current associated message identifier used for enqueuing messages using a sequence deviation. More... | |
void | SetRelativeMsgID (const Raw &value) |
Set a message identifier to use for enqueuing messages using a sequence deviation. More... | |
Enqueue object for queuing messages into an Oracle Queue.
This class wraps the OCILIB object handle OCI_Enqueue and its related methods
Definition at line 7370 of file ocilib.hpp.
Message enqueuing mode.
Possible values are Enqueue::EnqueueModeValues
Definition at line 7394 of file ocilib.hpp.
Message visibility after begin queued.
Possible values are Enqueue::EnqueueVisibilityValues
Definition at line 7416 of file ocilib.hpp.
Message enqueuing mode enumerated values.
Enumerator | |
---|---|
Before |
Enqueue message before another message |
OnTop |
Enqueue message before all messages |
Definition at line 7379 of file ocilib.hpp.
Message visibility enumerated values.
Enumerator | |
---|---|
Immediate |
Enqueue is an independent transaction |
OnCommit |
Enqueue is part of current transaction |
Definition at line 7401 of file ocilib.hpp.
Create a Enqueue object for the given queue.
typeInfo | - Type info handle |
queueName | - Queue name |
Definition at line 6186 of file ocilib_impl.hpp.
References ocilib::Check(), OCI_EnqueueCreate(), and OCI_EnqueueFree().
|
inline |
Enqueue a message the on queue associated to the Enqueue object.
message | - Message to enqueue |
Definition at line 6191 of file ocilib_impl.hpp.
References ocilib::Check(), and OCI_EnqueuePut().
|
inline |
Get the enqueuing/locking behavior.
Definition at line 6196 of file ocilib_impl.hpp.
References ocilib::Check(), and OCI_EnqueueGetVisibility().
|
inline |
Set whether the new message is enqueued as part of the current transaction.
value | - Enqueuing visibility |
Definition at line 6201 of file ocilib_impl.hpp.
References ocilib::Check(), and OCI_EnqueueSetVisibility().
|
inline |
Return the enqueuing mode of messages to enqueue.
Definition at line 6206 of file ocilib_impl.hpp.
References ocilib::Check(), and OCI_EnqueueGetSequenceDeviation().
|
inline |
Set the enqueuing mode of messages to put in the queue.
value | - enqueuing mode |
Definition at line 6211 of file ocilib_impl.hpp.
References ocilib::Check(), and OCI_EnqueueSetSequenceDeviation().
|
inline |
Get the current associated message identifier used for enqueuing messages using a sequence deviation.
Definition at line 6216 of file ocilib_impl.hpp.
References ocilib::Check(), ocilib::MakeRaw(), and OCI_EnqueueGetRelativeMsgID().
|
inline |
Set a message identifier to use for enqueuing messages using a sequence deviation.
value | - message identifier |
Definition at line 6227 of file ocilib_impl.hpp.
References ocilib::Check(), and OCI_EnqueueSetRelativeMsgID().