| Oracle® Data Provider for .NET Developer's Guide 11g Release 2 (11.2.0.1.2) Part Number E17357-04 |
|
|
View PDF |
| Oracle® Data Provider for .NET Developer's Guide 11g Release 2 (11.2.0.1.2) Part Number E17357-04 |
|
|
View PDF |
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
See Also:
OracleAQMessageAvailableEventArgs members are listed in the following tables.
OracleAQMessageAvailableEventArgs Properties
OracleAQMessageAvailableEventArgs properties are listed in Table 12-17.
Table 12-17 OracleAQMessageAvailableEventArgs Properties
| Property | Description |
|---|---|
|
Specifies the number of messages that raised this notification. |
|
|
Provides the name of the consumer for which the message is available for dequeuing. |
|
|
Provides the name of the consumer for which the message is available for dequeuing. |
|
|
Specifies the duration, in seconds, after which an enqueued message is available for dequeuing. |
|
|
Specifies the delivery mode of the message. |
|
|
Specifies the time when the message was enqueued. |
|
|
Specifies the name of the queue that the message is moved to if it cannot be processed successfully. |
|
|
Specifies the duration, in seconds, for which an enqueued message is available for dequeuing before expiring. |
|
|
Returns an array of message identifiers. |
|
|
Indicates the type of notification such as regular, grouping, or timeout. |
|
|
Specifies the ID of the message, in the last queue, that generated this message. |
|
|
Specifies the priority of the message. |
|
|
Indicates the name of the queue that contains the message to be dequeued. |
|
|
Identifies the original sender of the message. |
|
|
Specifies the state of the message. |
OracleAQMessageAvailableEventArgs properties are listed in Table 12-18.
Table 12-18 OracleAQMessageAvailableEventArgs Properties
| Property | Description |
|---|---|
|
Specifies the number of messages that raised this notification. |
|
|
Provides the name of the consumer for which the message is available for dequeuing. |
|
|
Provides the name of the consumer for which the message is available for dequeuing. |
|
|
Specifies the duration, in seconds, after which an enqueued message is available for dequeuing. |
|
|
Specifies the delivery mode of the message. |
|
|
Specifies the time when the message was enqueued. |
|
|
Specifies the name of the queue that the message is moved to if it cannot be processed successfully. |
|
|
Specifies the duration, in seconds, for which an enqueued message is available for dequeuing before expiring. |
|
|
Returns an array of message identifiers. |
|
|
Indicates the type of notification such as regular, grouping, or timeout. |
|
|
Specifies the ID of the message, in the last queue, that generated this message. |
|
|
Specifies the priority of the message. |
|
|
Indicates the name of the queue that contains the message to be dequeued. |
|
|
Identifies the original sender of the message. |
|
|
Specifies the state of the message. |
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
This instance property specifies the delivery mode of the message.
Declaration
// C#
public OracleAQMessageDeliveryMode DeliveryMode {get;}
Property Value
An OracleAQMessageDeliveryMode enumerated value.
See Also:
This instance property specifies the time when the message was enqueued.
Declaration
// C#
public DateTime EnqueueTime {get;}
Property Value
A DateTime object.
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
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.
See Also:
This property identifies the original sender of the message.
Declaration
// C#
public OracleAQAgent SenderId {get;}
Property Value
An OracleAQAgent object.
See Also:
This instance property specifies the state of the message.
Declaration
// C#
public OracleAQMessageState State {get;}
Property Value
An OracleAQMessageState enumerated value.
|
 Copyright © 2002, 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|