IMessageSession Interface

Gets the ID to identify this client. This can be used to correlate logs and exceptions.

Returns true if the client is closed or closing.

Gets the sequence number of the last peeked message.

Gets the time that the session identified by SessionId is locked until for this client.

Duration after which individual operations will timeout.

Returns true if connection is owned and false if connection is shared.

Gets the entity path.

Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using Receive. Setting a non-zero value prefetches PrefetchCount number of messages. Setting the value to zero turns prefetch off. Defaults to 0.

Gets the ReceiveMode of the current receiver.

Gets a list of currently registered plugins for this client.

Connection object to the service bus namespace.

Gets the SessionId.

Abandons a Message using a lock token. This will make the message available again for processing.

Closes the Client. Closes the connections opened by it.

Completes a series of Message using a list of lock tokens. This will delete the message from the service.

Completes a Message using its lock token. This will delete the message from the queue.

Moves a message to the deadletter sub-queue.

Moves a message to the deadletter sub-queue.

Indicates that the receiver wants to defer the processing for the message.

Gets the session state.

Fetches the next active message without changing the state of the receiver or the message source.

Fetches the next batch of active messages without changing the state of the receiver or the message source.

Peeks a batch of messages.

Asynchronously reads the next message without changing the state of the receiver or the message source.

Receive a message from the entity defined by Path using ReceiveMode mode.

Receives a maximum of maxMessageCount messages from the entity defined by Path using ReceiveMode mode.

Receives a maximum of maxMessageCount messages from the entity defined by Path using ReceiveMode mode.

Receive a message from the entity defined by Path using ReceiveMode mode.

Receives a IList<T> of deferred messages identified by sequenceNumbers.

Receives a specific deferred message identified by sequenceNumber.

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. This handler(Func<T1,T2,TResult>) is awaited on every time a new message is received by the receiver.

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. This handler(Func<T1,T2,TResult>) is awaited on every time a new message is received by the receiver.

Registers a ServiceBusPlugin to be used with this client.

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

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.

Renews the lock on the session specified by the SessionId. The lock will be renewed based on the setting specified on the entity.

Set a custom state on the session which can be later retrieved using GetStateAsync()

Unregister message handler from the receiver if there is an active message handler registered. This operation waits for the completion of inflight receive and message handling operations to finish and unregisters future receives on the message handler which previously registered.

Unregisters a ServiceBusPlugin.