BrokeredMessage.Abandon Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Overloads

Abandon()	Abandons the lock on a peek-locked message.
Abandon(IDictionary<String,Object>)	Abandons the lock on a peek-locked message.

Abandon()

Abandons the lock on a peek-locked message.

public void Abandon ();

member this.Abandon : unit -> unit

Public Sub Abandon ()

Exceptions

ObjectDisposedException

Thrown when the message is in the disposed state or the receiver with which the message was received is in disposed state.

InvalidOperationException

Thrown when invoked on a message that has not been received from the message server or invoked on a message that has not been received in peek-lock mode.

TimeoutException

Thrown when operation times out. The timeout period is initialized through the MessagingFactorySettings. You may need to increase the value of OperationTimeout to avoid this exception if the timeout value is relatively low.

MessagingCommunicationException

Thrown when the queue or subscription that receives the message is no longer present in the message server.

ServerBusyException

When service bus service is busy and is unable process the request.

MessagingEntityNotFoundException

When messaging entity the message was received from has been deleted.

MessageLockLostException

When the lock associated with this message was lost or the lock token was not found.

SessionLockLostException

When this message was received from a Session and the lock associated with the session was lost.

UnauthorizedAccessException

When the security token provided by the TokenProvider does not contain the claims to perform this operation.

QuotaExceededException

When the number of concurrent connections to an entity exceed the maximum allowed value.

Remarks

This operation should only be exercised on a message received in peek-lock mode.

Abandon(IDictionary<String,Object>)

Abandons the lock on a peek-locked message.

public void Abandon (System.Collections.Generic.IDictionary<string,object> propertiesToModify);

member this.Abandon : System.Collections.Generic.IDictionary<string, obj> -> unit

Public Sub Abandon (propertiesToModify As IDictionary(Of String, Object))

Parameters

propertiesToModify

IDictionary<String,Object>

The key-value pair collection of properties to modify.

Exceptions

ObjectDisposedException

Thrown when

InvalidOperationException

Thrown when

TimeoutException

Thrown when operation times out. Timeout period is initialized through the MessagingFactorySettings. You may need to increase the value of OperationTimeout to avoid this exception if timeout value is relatively low.

CommunicationException

Thrown when the queue or subscription that the message was received from is no longer present in the message server.

Remarks

This operation should only be exercised on a message received in peek-lock mode.