Click or drag to resize
QueueingServiceExtensionsClaimMessage Method
This API is preliminary and subject to change.

Note: This API is now obsolete.

Claim messages from a queue.

Namespace: net.openstack.Core.Synchronous
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
[ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")]
public static Claim ClaimMessage(
	this IQueueingService queueingService,
	QueueName queueName,
	Nullable<int> limit,
	TimeSpan timeToLive,
	TimeSpan gracePeriod
)

Parameters

queueingService
Type: net.openstack.Core.ProvidersIQueueingService
The queueing service instance.
queueName
Type: net.openstack.Core.Domain.QueuesQueueName
The queue name.
limit
Type: SystemNullableInt32
The maximum number of messages to claim. If this value is , a provider-specific default value is used.
timeToLive
Type: SystemTimeSpan
The time to wait before the server automatically releases the claim.
gracePeriod
Type: SystemTimeSpan
The time to wait, after the time-to-live for the claim expires, before the server allows the claimed messages to be deleted due to the individual message's time-to-live expiring.

Return Value

Type: Claim
A Claim object representing the claim.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueueingService. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentNullExceptionIf queueingService is .
ArgumentNullExceptionIf queueName is .
ArgumentOutOfRangeException If limit is less than or equal to 0.

-or-

If timeToLive is negative or Zero.

-or-

If gracePeriod is negative.

WebExceptionIf the REST request does not return successfully.
Remarks
When the claim is no longer required, the code should call DisposeAsync(CancellationToken) or Dispose to ensure the following actions are taken.
  • Messages which are part of this claim which were not processed are made available to other nodes.
  • The claim resource is cleaned up without waiting for the time-to-live to expire.

Messages which are not deleted before the claim is released will be eligible for reclaiming by another process.

Version Information

.NET Framework

Obsolete (compiler warning) in 4.5

openstack.net

Obsolete (compiler warning) in 1.6
Obsolete (compiler warning) in 1.5
Obsolete (compiler warning) in 1.4
Obsolete (compiler warning) in 1.3.6
See Also