SubscriptionClient.AcceptMessageSession Method

Definition

Overloads

AcceptMessageSession(String, Boolean, TimeSpan)
AcceptMessageSession(String, TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

AcceptMessageSession(String, Guid)
AcceptMessageSession(String, Boolean)
AcceptMessageSession(String, Guid, TimeSpan)
AcceptMessageSession(TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

AcceptMessageSession(String)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

AcceptMessageSession(Boolean)
AcceptMessageSession()

Accepts a message session that allows grouping of related messages for processing in a single transaction.

AcceptMessageSession(Boolean, TimeSpan)

AcceptMessageSession(String, Boolean, TimeSpan)

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, bool isExclusiveMode, TimeSpan serverWaitTime);
abstract member AcceptMessageSession : string * bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (sessionId As String, isExclusiveMode As Boolean, serverWaitTime As TimeSpan) As MessageSession

Parameters

sessionId
System.String
isExclusiveMode
System.Boolean
serverWaitTime
System.TimeSpan

Returns

MessageSession

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.String,System.Boolean,System.TimeSpan)

Applies to

AcceptMessageSession(String, TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, TimeSpan serverWaitTime);
abstract member AcceptMessageSession : string * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (sessionId As String, serverWaitTime As TimeSpan) As MessageSession

Parameters

sessionId
System.String

The session identifier of the message session.

serverWaitTime
System.TimeSpan

The time span the server waits for processing messages before it times out.

Returns

MessageSession

A MessageSession that allows grouping of related messages for processing in a single transaction.

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.String,System.TimeSpan)

Exceptions

System.ArgumentException

Thrown if sessionId is null, empty, or white spaces.

System.ArgumentOutOfRangeException

Thrown if serverWaitTime is not a positive TimeSpan value.

System.TimeoutException

Thrown if the operation exceeded the timeout value set by serverWaitTime.

System.OperationCanceledException

Thrown if the client is already closed, aborted, or disposed.

Applies to

AcceptMessageSession(String, Guid)

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, Guid lockToken);
abstract member AcceptMessageSession : string * Guid -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * Guid -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (sessionId As String, lockToken As Guid) As MessageSession

Parameters

sessionId
System.String
lockToken
System.Guid

Returns

MessageSession

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.String,System.Guid)

Applies to

AcceptMessageSession(String, Boolean)

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, bool isExclusiveMode);
abstract member AcceptMessageSession : string * bool -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * bool -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (sessionId As String, isExclusiveMode As Boolean) As MessageSession

Parameters

sessionId
System.String
isExclusiveMode
System.Boolean

Returns

MessageSession

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.String,System.Boolean)

Applies to

AcceptMessageSession(String, Guid, TimeSpan)

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, Guid lockToken, TimeSpan serverWaitTime);
abstract member AcceptMessageSession : string * Guid * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * Guid * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (sessionId As String, lockToken As Guid, serverWaitTime As TimeSpan) As MessageSession

Parameters

sessionId
System.String
lockToken
System.Guid
serverWaitTime
System.TimeSpan

Returns

MessageSession

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.String,System.Guid,System.TimeSpan)

Applies to

AcceptMessageSession(TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (TimeSpan serverWaitTime);
abstract member AcceptMessageSession : TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (serverWaitTime As TimeSpan) As MessageSession

Parameters

serverWaitTime
System.TimeSpan

The time span the server waits for processing messages before it times out.

Returns

MessageSession

A MessageSession that allows grouping of related messages for processing in a single transaction.

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.TimeSpan)

Exceptions

System.ArgumentOutOfRangeException

Thrown if serverWaitTime is not a positive TimeSpan value.

System.TimeoutException

Thrown if the operation exceeded the timeout value set by serverWaitTime.

System.OperationCanceledException

Thrown if the client is already closed, aborted, or disposed.

Applies to

AcceptMessageSession(String)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId);
abstract member AcceptMessageSession : string -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (sessionId As String) As MessageSession

Parameters

sessionId
System.String

The session identifier of the message session.

Returns

MessageSession

A MessageSession that allows grouping of related messages for processing in a single transaction.

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.String)

Exceptions

System.ArgumentException

Thrown if sessionId is null, empty, or white spaces.

System.TimeoutException

Thrown if the operation exceeded the timeout value set by OperationTimeout.

System.OperationCanceledException

Thrown if the client is already closed, aborted, or disposed.

Applies to

AcceptMessageSession(Boolean)

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (bool isExclusiveMode);
abstract member AcceptMessageSession : bool -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : bool -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (isExclusiveMode As Boolean) As MessageSession

Parameters

isExclusiveMode
System.Boolean

Returns

MessageSession

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.Boolean)

Applies to

AcceptMessageSession()

Accepts a message session that allows grouping of related messages for processing in a single transaction.

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession ();
abstract member AcceptMessageSession : unit -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : unit -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession () As MessageSession

Returns

MessageSession

A MessageSession that allows grouping of related messages for processing in a single transaction.

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession

Applies to

AcceptMessageSession(Boolean, TimeSpan)

public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (bool isExclusiveMode, TimeSpan serverWaitTime);
abstract member AcceptMessageSession : bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
Public Function AcceptMessageSession (isExclusiveMode As Boolean, serverWaitTime As TimeSpan) As MessageSession

Parameters

isExclusiveMode
System.Boolean
serverWaitTime
System.TimeSpan

Returns

MessageSession

Implements

Microsoft.ServiceBus.Messaging.IMessageSessionEntity.AcceptMessageSession(System.Boolean,System.TimeSpan)

Applies to