Struct mimir::DeqOptions

pub struct DeqOptions { /* fields omitted */ }

Dequeue option handles are used to represent the options specified when dequeuing messages using advanced queueing.

Methods

impl Options

fn add_ref(&self) -> Result<()>

Adds a reference to the dequeue options. This is intended for situations where a reference to the dequeue options needs to be maintained independently of the reference returned when the handle was created.

fn get_condition(&self) -> Result<String>

Returns the condition that must be satisfied in order for a message to be dequeued. See function dequeue::Options::set_condition() for more information.

fn get_consumer_name(&self) -> Result<String>

Returns the name of the consumer that is dequeuing messages. See function dequeue::Options::set_consumer_name() for more information.

fn get_correlation(&self) -> Result<String>

Returns the correlation of the message to be dequeued. See function dequeue::Options::set_correlation() for more information.

fn get_mode(&self) -> Result<ODPIDeqMode>

Returns the mode that is to be used when dequeuing messages.

fn get_msg_id(&self) -> Result<String>

Returns the identifier of the specific message that is to be dequeued.

fn get_navigation(&self) -> Result<ODPIDeqNavigation>

Returns the position of the message that is to be dequeued.

fn get_transformation(&self) -> Result<String>

Returns the transformation of the message to be dequeued. See function dequeue::Options::set_transformation() for more information.

fn get_visibility(&self) -> Result<ODPIVisibility>

Returns whether the message being dequeued is part of the current transaction or constitutes a transaction on its own.

fn get_wait(&self) -> Result<u32>

Returns the time to wait, in seconds, for a message matching the search criteria. See function dequeue::Options::set_wait() for more information.

fn release(&self) -> Result<()>

Releases a reference to the dequeue options. A count of the references to the dequeue options is maintained and when this count reaches zero, the memory associated with the options is freed.

fn set_condition(&self, condition: Option<&str>) -> Result<()>

Sets the condition which must be true for messages to be dequeued. The condition must be a valid boolean expression similar to the where clause of a SQL query. The expression can include conditions on message properties, user data properties and PL/SQL or SQL functions. User data properties must be prefixed with tab.user_data as a qualifier to indicate the specific column of the queue table that stores the message payload.

• condition - a string in the encoding used for CHAR data, or None if the condition is to be cleared.

fn set_consumer_name(&self, cosumer_name: Option<&str>) -> Result<()>

Sets the name of the consumer which will be dequeuing messages. This value should only be set if the queue is set up for multiple consumers.

• consumer_name - a string in the encoding used for CHAR data, or None if the consumer name is to be cleared.

fn set_correlation(&self, correlation: Option<&str>) -> Result<()>

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

• correlation - a string in the encoding used for CHAR data, or None if the correlation is to be cleared.

fn set_mode(&self, mode: ODPIDeqMode) -> Result<()>

Sets the mode that is to be used when dequeuing messages.

• mode - he mode that should be used. It should be one of the values from the enumeration ODPIDeqMode.

fn set_msg_id(&self, msg_id: Option<&str>) -> Result<()>

Sets the identifier of the specific message to be dequeued.

• msg_id - a string making up the message identifier, or None if no specific message is to be dequeued.

fn set_navigation(&self, nav: ODPIDeqNavigation) -> Result<()>

Sets the position in the queue of the message that is to be dequeued.

• nav - the value that should be used. It should be one of the values from the enumeration ODPIDeqNavigation.

fn set_transformation(&self, transform: Option<&str>) -> Result<()>

Sets the transformation of the message to be dequeued. The transformation is applied after the message is dequeued but before it is returned to the application. It must be created using DBMS_TRANSFORM.

• transform - a string in the encoding used for CHAR data, or None if the transformation is to be cleared.

fn set_visibility(&self, visibility: ODPIVisibility) -> Result<()>

Sets whether the message being dequeued is part of the current transaction or constitutes a transaction on its own.

• visibility - the value that should be used. It should be one of the values from the enumeration ODPIVisibility.

fn set_wait(&self, wait: u32) -> Result<()>

Set the time to wait, in seconds, for a message matching the search criteria.

• wait - the number of seconds to wait for a message matching the search criteria. Any integer is valid but the predefined constants DPI_DEQ_WAIT_NO_WAIT and DPI_DEQ_WAIT_FOREVER are provided as a convenience.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<*mut ODPIDeqOptions> for Options

fn from(inner: *mut ODPIDeqOptions) -> Options

Performs the conversion.