OracleAQEnqueueOptions Class

The OracleAQEnqueueOptions class represents the options available when enqueuing a message to an OracleAQQueue.

Class Inheritance

System.Object

OracleAQEnqueueOptions

Declaration

// C#
public sealed class OracleAQEnqueueOptions : ICloneable

Thread Safety

All public static methods are thread-safe, although instance methods do not guarantee thread safety.

Requirements

Namespace: Oracle.DataAccess.Client

Assembly: Oracle.DataAccess.dll

ODP.NET Version: ODP.NET for .NET Framework 2.0 or ODP.NET for .NET Framework 4

See Also:

"Oracle.DataAccess.Client Namespace"
OracleAQEnqueueOptions Members
OracleAQEnqueueOptions Constructor
OracleAQEnqueueOptions Properties
OracleAQEnqueueOptions Public Methods

OracleAQEnqueueOptions Members

The OracleAQEnqueueOptions members are listed in the following tables.

OracleAQEnqueueOptions Constructor

OracleAQEnqueueOptions constructor is listed in Table 12-9.

Table 12-9 OracleAQEnqueueOptions Constructor

Constructor	Description
OracleAQEnqueueOptions Constructor	Instantiates a new instance of the `OracleAQEnqueueOptions` class.

OracleAQEnqueueOptions Properties

OracleAQEnqueueOptions properties are listed in Table 12-10.

Table 12-10 OracleAQEnqueueOptions Properties

Property	Description
DeliveryMode	Specifies the delivery mode of the message being enqueued.
Visibility	Specifies whether or not the new message is enqueued as part of the current transaction.

OracleAQEnqueueOptions Public Methods

The OracleAQEnqueueOptions public method is listed in Table 12-11.

Table 12-11 OracleAQEnqueueOptions Public Methods

Public Method	Description
Clone	Creates a copy of an `OracleAQEnqueueOptions` object.

See Also:

OracleAQEnqueueOptions Constructor

This constructor creates an instance of the OracleAQEnqueueOptions class with default property values.

Declaration

// C#
public OracleAQEnqueueOptions();

See Also:

"Oracle.DataAccess.Client Namespace"
OracleAQEnqueueOptions Class
OracleAQEnqueueOptions Members

OracleAQEnqueueOptions Properties

OracleAQEnqueueOptions properties are listed in Table 12-12.

Table 12-12 OracleAQEnqueueOptions Properties

Property	Description
DeliveryMode	Specifies the delivery mode of the message being enqueued.
Visibility	Specifies whether or not the new message is enqueued as part of the current transaction.

See Also:

"Oracle.DataAccess.Client Namespace"
OracleAQEnqueueOptions Class
OracleAQEnqueueOptions Members

DeliveryMode

This instance property specifies the delivery mode of the message being enqueued.

Declaration

// C#
public OracleAQMessageDeliveryMode DeliveryMode {get;set;}

Exceptions

ArgumentOutOfRangeException - The specified Visibility value is invalid.

Remarks

The valid values can be any of the following enumerated values:

OracleAQMessageDeliveryMode.Persistent
OracleAQMessageDeliveryMode.Buffered

The default is OracleAQMessageDeliveryMode.Persistent.

OracleAQMessageDeliveryMode.PersistentOrBuffered cannot be set on this property.

OracleAQMessageDeliveryMode.Buffered can be specified only with Oracle Database 10g release 2 (10.2) or higher. Buffered messaging is supported in all queue tables created with a database compatibility level of 8.1 or higher.

See Also:

"Oracle.DataAccess.Client Namespace"
OracleAQEnqueueOptions Class
OracleAQEnqueueOptions Members

Visibility

This instance property specifies whether or not the new message is enqueued as part of the current transaction.

Declaration

// C#
public OracleAQVisibilityMode Visibility {get;set;}

Property Value

An OracleAQVisibilityMode enumerated value.

Exceptions

ArgumentOutOfRangeException - The specified Visibility value is invalid.

Remarks

The default value is OracleAQVisibilityMode.OnCommit. You must use transactions when using the default value. If transactions are not used when using the default visibility mode of OracleAQVisibilityMode.OnCommit, then messages are not enqueued to the queue.

Using the alternative visibility mode value, OracleAQVisibilityMode.Immediate eliminates the need to use a transaction. The queue is not affected in case the enqueue operation fails. The message does not get enqueued to the queue for such cases.

See Also:

"Oracle.DataAccess.Client Namespace"
OracleAQEnqueueOptions Class
OracleAQEnqueueOptions Members

OracleAQEnqueueOptions Public Methods

OracleAQEnqueueOptions public method is listed in Table 12-13.

Table 12-13 OracleAQEnqueueOptions Public Methods

Public Method	Description
Clone	Creates a copy of an `OracleAQEnqueueOptions` object.

See Also:

"Oracle.DataAccess.Client Namespace"
OracleAQEnqueueOptions Class
OracleAQEnqueueOptions Members

Clone

This method creates a copy of an OracleAQEnqueueOptions object.

Declaration

// C#
public object Clone();

Return Value

An OracleAQEnqueueOptions object.

Implements

ICloneable.

Remarks

The cloned object has the same property values as that of the object being cloned.

See Also: