Struct mimir::MsgProps
[−]
[src]
pub struct MsgProps { /* fields omitted */ }ODPI-C Message Props wrapper.
Methods
impl Properties[src]
pub fn get_num_attempts(&self) -> Result<i32>[src]
Returns the number of attempts that have been made to dequeue a message.
pub fn get_correlation(&self) -> Result<String>[src]
Returns the correlation supplied by the producer when the message was enqueued.
pub fn get_delay(&self) -> Result<i32>[src]
Returns the number of seconds the enqueued message will be delayed.
pub fn get_delivery_mode(&self) -> Result<ODPIMessageDeliveryMode>[src]
Returns the mode that was used to deliver the message.
pub fn get_enq_time(&self) -> Result<DateTime<Utc>>[src]
Returns the time that the message was enqueued.
pub fn get_exception_q(&self) -> Result<String>[src]
Returns the name of the queue to which the message is moved if it cannot be processed
successfully. See function MsgProps::set_exception_q() for more information.
pub fn get_expiration(&self) -> Result<i32>[src]
Returns the number of seconds the message is available to be dequeued. See function
MsgProps::set_expiration() for more information.
pub fn get_original_msg_id(&self) -> Result<String>[src]
Returns the id of the message in the last queue that generated this message. See function
MsgProps::set_original_msg_id() for more information.
pub fn get_priority(&self) -> Result<i32>[src]
Returns the priority assigned to the message. See function MsgProps::set_priority() for
more information.
pub fn get_state(&self) -> Result<ODPIMessageState>[src]
Returns the state of the message at the time of dequeue.
pub fn set_correlation(&self, correlation: &str) -> Result<()>[src]
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.
pub fn set_delay(&self, delay: i32) -> Result<()>[src]
Sets the number of seconds to delay the message before it can be dequeued. Messages enqueued
with a delay are put into the Waiting state. When the delay expires the message is put
into the Ready state. Dequeuing directly by message id overrides this delay specification.
Note that delay processing requires the queue monitor to be started.
pub fn set_exception_q(&self, queue_name: &str) -> Result<()>[src]
Sets the name of the queue to which the message is moved if it cannot be processed
successfully. Messages are moved if the number of unsuccessful dequeue attempts has reached
the maximum allowed number or if the message has expired. All messages in the exception
queue are in the Expired state.
pub fn set_expiration(&self, seconds: i32) -> Result<()>[src]
Sets the number of seconds the message is available to be dequeued. This value is an offset
from the delay. Expiration processing requires the queue monitor to be running. Until this
time elapses, the messages are in the queue in the state Ready. After this time elapses
messages are moved to the exception queue in the Expired state.
pub fn set_original_msg_id(&self, id: &str) -> Result<()>[src]
Sets the id of the message in the last queue that generated this message.
pub fn set_priority(&self, priority: i32) -> Result<()>[src]
Sets the priority assigned to the message. A smaller number indicates a higher priority. The priority can be any number, including negative numbers.
Trait Implementations
impl Clone for Properties[src]
fn clone(&self) -> Properties[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more