OracleAQMessageAvailableEventArgs Class

The OracleAQMessageAvailableEventArgs class provides event data for the OracleAQQueue.MessageAvailable event.

Class Inheritance

System.Object

  System.EventArgs

    Oracle.DataAccess.Client.OracleAQMessageAvailableEventArgs

Declaration

// C#
public sealed class OracleAQMessageAvailableEventArgs

Thread Safety

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

Remarks

This class cannot be inherited.

For detailed information on all the inherited properties and methods, please read the documentation provided by Microsoft's .NET Documentation.

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

---

OracleAQMessageAvailableEventArgs Members

OracleAQMessageAvailableEventArgs members are listed in the following tables.

OracleAQMessageAvailableEventArgs Properties

OracleAQMessageAvailableEventArgs properties are listed in Table 12-17.

---

OracleAQMessageAvailableEventArgs Properties

OracleAQMessageAvailableEventArgs properties are listed in Table 12-18.

AvailableMessages

This instance property specifies the number of messages that raised this notification.

Declaration

// C#
public int AvailableMessages{get;}

Property Value

An integer indicating the number of messages that raised this notification.

Remarks

The property value is 1 for a regular notification type. The notification type can be specified using the OracleAQQueue.Notification property.

This property is not relevant if the NotificationType is OracleAQNotificationType.Timeout.

ConsumerName

This property provides the name of the consumer for which the message is available for dequeuing.

Declaration

// C#
public string ConsumerName {get;}

Property Value

A string that identifies the name of the consumer.

Correlation

This instance property specifies the identification for the message.

Declaration

// C#
public string Correlation {get;}

Property Value

A string that specifies the identification for the message.

Remarks

This property specifies the correlation of the message for which the notification is raised. The consumer can then use this identification to dequeue specific messages by setting the "Correlation" property of the OracleAQDequeueOptions object.

Delay

This instance property specifies the duration, in seconds, after which an enqueued message is available for dequeuing.

Declaration

// C#
public int Delay {get;}

Property Value

An integer that indicates the duration, in seconds, after which an enqueued message is available for dequeuing.

DeliveryMode

This instance property specifies the delivery mode of the message.

Declaration

// C#
public OracleAQMessageDeliveryMode DeliveryMode {get;}

Property Value

An OracleAQMessageDeliveryMode enumerated value.

EnqueueTime

This instance property specifies the time when the message was enqueued.

Declaration

// C#
public DateTime EnqueueTime {get;}

Property Value

A DateTime object.

ExceptionQueue

This instance property specifies the name of the queue that the message is moved to if it cannot be processed successfully.

Declaration

// C#
public string ExceptionQueue {get;}

Property Value

The name of the queue that a message to is moved if it cannot be processed successfully.

Expiration

This instance property specifies the duration, in seconds, for which an enqueued message is available for dequeuing before expiring.

Declaration

// C#
public int Expiration {get;}

Property Value

An integer that specifies the duration, in seconds, for which an enqueued message is available for dequeuing.

MessageId

This instance property returns an array of message identifiers.

Declaration

// ADO.NET 2.0: C#
public byte[ ][ ] MessageId{get;}

Property Value

A byte[ ][ ] that specifies the message identifiers received as part of the notification.

Remarks

This property specifies the message identifiers of the messages that raise the notification.

The size of the MessageId array is 1 for regular notifications. The size of the MessageId array is 1 for grouping notifications if the notification grouping type is OracleAQNotificationGroupingType.Last. This property is not relevant if the NotificationType is OracleAQNotificationType.Timeout.

NotificationType

This property indicates the type of notification such as regular, grouping, or timeout.

Declaration

// C#
public OracleAQNotificationType NotificationType {get;}

Property Value

An OracleAQNotificationType enum value.

OriginalMessageId

This property specifies the ID of the message, in the last queue, that generated this message.

Declaration

// C#
public byte[] OriginalMessageId {get;}

Property Value

A byte[] that specifies the original message ID.

Priority

This instance property specifies the priority of the message.

Declaration

// C#
public int Priority {get;}

Property Value

An integer that specifies the priority of the message.

QueueName

This property indicates the name of the queue that contains the message to be dequeued.

Declaration

// C#
public string QueueName {get;}

Property Value

A string.

SenderId

This property identifies the original sender of the message.

Declaration

// C#
public OracleAQAgent SenderId {get;}

Property Value

An OracleAQAgent object.

State

This instance property specifies the state of the message.

Declaration

// C#
public OracleAQMessageState State {get;}

Property Value

An OracleAQMessageState enumerated value.