Click or drag to resize
IQueueingService Methods
This API is preliminary and subject to change.

The IQueueingService type exposes the following members.

Methods
  NameDescription
Public methodClaimMessageAsync
Claim messages from a queue.
Public methodCode exampleCreateQueueAsync
Creates a queue, if it does not already exist.
Public methodDeleteMessageAsync
Deletes a message from a queue.
Public methodDeleteMessagesAsync
Deletes messages from a queue.
Public methodCode exampleDeleteQueueAsync
Deletes a queue.
Public methodCode exampleGetHomeAsync
Gets the home document describing the operations supported by the service.
Public methodGetMessageAsync
Gets detailed information about a specific queued message.
Public methodGetMessagesAsync
Get messages from a queue.
Public methodCode exampleGetNodeHealthAsync
Checks the queueing service node status.
Public methodGetQueueMetadataAsync(QueueName, CancellationToken)
Gets the metadata associated with a queue.
Public methodGetQueueMetadataAsyncT(QueueName, CancellationToken)
Gets the metadata associated with a queue, as a strongly-typed object.
Public methodGetQueueStatisticsAsync
Gets statistics for a queue.
Public methodListMessagesAsync
Gets a list of messages currently in a queue.
Public methodCode exampleListQueuesAsync
Gets a list of queues.
Public methodPostMessagesAsync(QueueName, IEnumerableMessage, CancellationToken)
Posts messages to a queue.
Public methodPostMessagesAsync(QueueName, CancellationToken, Message)
Posts messages to a queue.
Public methodPostMessagesAsyncT(QueueName, IEnumerableMessageT, CancellationToken)
Posts messages to a queue.
Public methodPostMessagesAsyncT(QueueName, CancellationToken, MessageT)
Posts messages to a queue.
Public methodQueryClaimAsync
Gets detailed information about the current state of a claim.
Public methodCode exampleQueueExistsAsync
Checks for the existence of a queue with a particular name.
Public methodReleaseClaimAsync
Immediately release a claim, making any (remaining, non-deleted) messages associated with the claim available to other workers.
Public methodSetQueueMetadataAsyncT
Sets the metadata associated with a queue.
Public methodUpdateClaimAsync
Renews a claim, by updating the time-to-live and resetting the age of the claim to zero.
Top
Extension Methods
  NameDescription
Public Extension MethodClaimMessage
Claim messages from a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodCreateQueue
Creates a queue, if it does not already exist.
(Defined by QueueingServiceExtensions.)
Public Extension MethodDeleteMessage
Deletes a message from a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodDeleteMessages
Deletes messages from a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodDeleteQueue
Deletes a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetHome
Gets the home document describing the operations supported by the service.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetMessage
Gets detailed information about a specific queued message.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetMessages
Get messages from a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetNodeHealth
Checks the queueing service node status.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetQueueMetadata(QueueName)Overloaded.
Gets the metadata associated with a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetQueueMetadataT(QueueName)Overloaded.
Gets the metadata associated with a queue, as a strongly-typed object.
(Defined by QueueingServiceExtensions.)
Public Extension MethodGetQueueStatistics
Gets statistics for a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodListMessages
Gets a list of messages currently in a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodListQueues
Gets a list of queues.
(Defined by QueueingServiceExtensions.)
Public Extension MethodPostMessages(QueueName, IEnumerableMessage)Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodPostMessages(QueueName, Message)Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodPostMessagesT(QueueName, IEnumerableMessageT)Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodPostMessagesT(QueueName, MessageT)Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodQueryClaim
Gets detailed information about the current state of a claim.
(Defined by QueueingServiceExtensions.)
Public Extension MethodQueueExists
Checks for the existence of a queue with a particular name.
(Defined by QueueingServiceExtensions.)
Public Extension MethodReleaseClaim
Immediately release a claim, making any (remaining, non-deleted) messages associated with the claim available to other workers.
(Defined by QueueingServiceExtensions.)
Public Extension MethodSetQueueMetadataT
Sets the metadata associated with a queue.
(Defined by QueueingServiceExtensions.)
Public Extension MethodUpdateClaim
Renews a claim, by updating the time-to-live and resetting the age of the claim to zero.
(Defined by QueueingServiceExtensions.)
Top
See Also