QueueClient.AcceptMessageSession Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
AcceptMessageSession(String, Guid, TimeSpan) |
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. |
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) |
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. |
AcceptMessageSession(String, Boolean) |
Accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode. |
AcceptMessageSession(String, Boolean, TimeSpan) |
Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. |
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) |
Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode. |
AcceptMessageSession() |
Accepts a message session that allows grouping of related messages for processing in a single transaction. |
AcceptMessageSession(Boolean, TimeSpan) |
Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode. |
AcceptMessageSession(String, Guid, TimeSpan)
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token.
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
- String
The session identifier of the message session.
- lockToken
- Guid
The session locktoken
- serverWaitTime
- TimeSpan
The server wait timeout
Returns
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
- String
The session identifier of the message session.
- serverWaitTime
- TimeSpan
The time span the server waits for processing messages before it times out.
Returns
A MessageSession that allows grouping of related messages for processing in a single transaction.
Exceptions
Thrown if sessionId is null, empty, or white spaces.
Thrown if serverWaitTime
is not a positive TimeSpan value.
Thrown if the operation exceeded the timeout value set by OperationTimeout.
Thrown if the client is already closed, aborted, or disposed.
Applies to
AcceptMessageSession(String, Guid)
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token.
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
- String
The session identifier of the message session.
- lockToken
- Guid
The session lock token.
Returns
A MessageSession that allows grouping of related messages for processing in a single transaction.
Applies to
AcceptMessageSession(String, Boolean)
Accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode.
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
- String
The session identifier of the message session.
- isExclusiveMode
- Boolean
Ture if exclusive mode, or false is not.
Returns
A MessageSession that allows grouping of related messages for processing in a single transaction.
Applies to
AcceptMessageSession(String, Boolean, TimeSpan)
Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode.
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
- String
The session identifier of the message session.
- isExclusiveMode
- Boolean
Ture if exclusive mode, or false is not.
- serverWaitTime
- TimeSpan
The server wait timeout
Returns
A MessageSession that allows grouping of related messages for processing in a single transaction.
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
- TimeSpan
The time span the server waits for processing messages before it times out.
Returns
A MessageSession that allows grouping of related messages for processing in a single transaction.
Exceptions
Thrown if serverWaitTime
is not a positive TimeSpan value.
Thrown if the operation exceeded
the timeout value set by serverWaitTime
.
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
- String
The session identifier of the message session.
Returns
A MessageSession that allows grouping of related messages for processing in a single transaction.
Exceptions
Thrown if sessionId is null, empty, or white spaces.
Thrown if the operation exceeded the timeout value set by OperationTimeout.
Thrown if the client is already closed, aborted, or disposed.
Applies to
AcceptMessageSession(Boolean)
Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode.
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
- Boolean
Ture if exclusive mode, or false is not.
Returns
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
A MessageSession that allows grouping of related messages for processing in a single transaction.
Exceptions
Thrown if the operation exceeded the timeout value set by OperationTimeout.
Thrown if the client is already closed, aborted, or disposed.
Applies to
AcceptMessageSession(Boolean, TimeSpan)
Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode.
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
- Boolean
Ture if exclusive mode, or false is not.
- serverWaitTime
- TimeSpan
The server wait timeout