Task<Claim> ClaimMessageAsync(
	QueueName queueName,
	Nullable<int> limit,
	TimeSpan timeToLive,
	TimeSpan gracePeriod,
	CancellationToken cancellationToken
)

Function ClaimMessageAsync ( 
	queueName As QueueName,
	limit As Nullable(Of Integer),
	timeToLive As TimeSpan,
	gracePeriod As TimeSpan,
	cancellationToken As CancellationToken
) As Task(Of Claim)

Task<Claim^>^ ClaimMessageAsync(
	QueueName^ queueName, 
	Nullable<int> limit, 
	TimeSpan timeToLive, 
	TimeSpan gracePeriod, 
	CancellationToken cancellationToken
)

abstract ClaimMessageAsync : 
        queueName : QueueName * 
        limit : Nullable<int> * 
        timeToLive : TimeSpan * 
        gracePeriod : TimeSpan * 
        cancellationToken : CancellationToken -> Task<Claim> 

Parameters

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.

cancellationToken

Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.

Return Value

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.

.NET Framework

openstack.net

Reference

Other Resources