MessageReceiver.RenewLockAsync Method

Definition

Namespace:

Microsoft.Azure.ServiceBus.Core

Assembly:

Microsoft.Azure.ServiceBus.dll

Package:

Microsoft.Azure.ServiceBus v5.2.0

Overloads

RenewLockAsync(Message)	Renews the lock on the message specified by the lock token. The lock will be renewed based on the setting specified on the queue.
RenewLockAsync(String)	Renews the lock on the message. The lock will be renewed based on the setting specified on the queue. New lock token expiry date and time in UTC format.

RenewLockAsync(Message)

Source:

MessageReceiver.cs

Renews the lock on the message specified by the lock token. The lock will be renewed based on the setting specified on the queue.

public System.Threading.Tasks.Task RenewLockAsync (Microsoft.Azure.ServiceBus.Message message);

abstract member RenewLockAsync : Microsoft.Azure.ServiceBus.Message -> System.Threading.Tasks.Task
override this.RenewLockAsync : Microsoft.Azure.ServiceBus.Message -> System.Threading.Tasks.Task

Public Function RenewLockAsync (message As Message) As Task

Parameters

message

Message

Returns

Task

Implements

RenewLockAsync(Message)

Remarks

When a message is received in PeekLock mode, the message is locked on the server for this receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration). If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, it resets the time the message is locked by the LockDuration set on the Entity.

RenewLockAsync(String)

Source:

MessageReceiver.cs

Renews the lock on the message. The lock will be renewed based on the setting specified on the queue. New lock token expiry date and time in UTC format.

public System.Threading.Tasks.Task<DateTime> RenewLockAsync (string lockToken);

abstract member RenewLockAsync : string -> System.Threading.Tasks.Task<DateTime>
override this.RenewLockAsync : string -> System.Threading.Tasks.Task<DateTime>

Public Function RenewLockAsync (lockToken As String) As Task(Of DateTime)

Parameters

lockToken

String

Lock token associated with the message.

Returns

Task<DateTime>

Implements

RenewLockAsync(String)

Remarks

When a message is received in PeekLock mode, the message is locked on the server for this receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration). If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, it resets the time the message is locked by the LockDuration set on the Entity.