Claim.RenewAsync Method

ClaimRenewAsync Method

This API is preliminary and subject to change.

Renews the claim by resetting the age and updating the TTL for the claim.

Namespace: net.openstack.Core.Domain.Queues
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

public Task RenewAsync(
	TimeSpan timeToLive,
	CancellationToken cancellationToken
)

Public Function RenewAsync ( 
	timeToLive As TimeSpan,
	cancellationToken As CancellationToken
) As Task

public:
Task^ RenewAsync(
	TimeSpan timeToLive, 
	CancellationToken cancellationToken
)

member RenewAsync : 
        timeToLive : TimeSpan * 
        cancellationToken : CancellationToken -> Task

Parameters

timeToLive: Type: SystemTimeSpan
The new Time-To-Live value for the claim. This value may differ from the original TTL of the claim.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.

Return Value

Type: Task
A Task object representing the asynchronous operation.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	If timeToLive is negative or Zero.
InvalidOperationException	If the claim is empty (i.e. Messages is empty).

Remarks

This method calls UpdateClaimAsync(QueueName, Claim, TimeSpan, CancellationToken) to renew the current claim, and then synchronously updates the current instance to reflect the new age and time-to-live values.

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6

Reference

Claim Class

net.openstack.Core.Domain.Queues Namespace