MessageSubscription T  MembersDH.Messaging Documentation

[This is preliminary documentation and is subject to change.]

The MessageSubscription T  type exposes the following members.
Constructors

  NameDescription
Public methodMessageSubscription T 
Back to Top
Methods

  NameDescription
Public methodAddMessage
Add a message to the message queue
Public methodChangeCapacity
Update the capacity of the message queue
Public methodClearMessages
Clear all messages currently in the message queue for this subscription instance
(Overrides SubscriptionBase ClearMessages .)
Public methodGetNextMessage
Get the next message in the message queue
Back to Top
Fields

  NameDescription
Protected fieldMessages
Message queue for the current subscription
Back to Top
Properties

  NameDescription
Public propertyActive
Whether the subscription is active and should receive and process messages
(Inherited from SubscriptionBase.)
Public propertyHasMessages
True if there are messages in the message queue
(Overrides SubscriptionBase HasMessages.)
Public propertyMaxMessages
Sets the maximum number of messages for the subscription. Enforced minimum is 1.
Public propertyMessageCount
Number of messages in the current message queue
Public propertyMessageType
The message type handled by this subscription
(Overrides SubscriptionBase MessageType.)
Back to Top
Events

  NameDescription
Public eventOnMessageReceived
Fired when the messages are received if there are subscribers to the event.
Back to Top
See Also