MessageSession MessageSession Class

Definition

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

public abstract class MessageSession : Microsoft.ServiceBus.Messaging.MessageReceiver
Public MustInherit Class MessageSession
Inherits MessageReceiver
Inheritance

Properties

BatchFlushInterval BatchFlushInterval Inherited from MessageReceiver
BatchingEnabled BatchingEnabled Inherited from MessageReceiver
IsClosed IsClosed Inherited from ClientEntity
LastPeekedSequenceNumber LastPeekedSequenceNumber

Gets or sets the last peeked sequence number in the session.

LockedUntilUtc LockedUntilUtc

Gets or sets the date and time at which the message session is unlocked.

Mode Mode Inherited from MessageReceiver
OffsetInclusive OffsetInclusive Inherited from MessageReceiver
Path Path

h of the queue or topic, relative to the MessagingFactory base address.

PrefetchCount PrefetchCount

Gets or sets the number of messages that the message receiver can simultaneously request.

ReceiverStartTime ReceiverStartTime Inherited from MessageReceiver
RetryPolicy RetryPolicy Inherited from ClientEntity
SessionId SessionId

Gets or sets the message session identifier.

StartOffset StartOffset Inherited from MessageReceiver
SupportsGetRuntimeEntityDescription SupportsGetRuntimeEntityDescription
ThisLock ThisLock Inherited from ClientEntity

Methods

Abandon(Guid) Abandon(Guid) Inherited from MessageReceiver
Abandon(Guid, IDictionary<String,Object>) Abandon(Guid, IDictionary<String,Object>) Inherited from MessageReceiver
AbandonAsync(Guid) AbandonAsync(Guid) Inherited from MessageReceiver
AbandonAsync(Guid, IDictionary<String,Object>) AbandonAsync(Guid, IDictionary<String,Object>) Inherited from MessageReceiver
Abort() Abort() Inherited from ClientEntity
Close() Close() Inherited from ClientEntity
CloseAsync() CloseAsync() Inherited from ClientEntity
Complete(Guid) Complete(Guid) Inherited from MessageReceiver
CompleteAsync(Guid) CompleteAsync(Guid) Inherited from MessageReceiver
CompleteBatch(IEnumerable<Guid>) CompleteBatch(IEnumerable<Guid>) Inherited from MessageReceiver
CompleteBatchAsync(IEnumerable<Guid>) CompleteBatchAsync(IEnumerable<Guid>) Inherited from MessageReceiver
DeadLetter(Guid) DeadLetter(Guid) Inherited from MessageReceiver
DeadLetter(Guid, IDictionary<String,Object>) DeadLetter(Guid, IDictionary<String,Object>) Inherited from MessageReceiver
DeadLetter(Guid, String, String) DeadLetter(Guid, String, String) Inherited from MessageReceiver
DeadLetterAsync(Guid) DeadLetterAsync(Guid) Inherited from MessageReceiver
DeadLetterAsync(Guid, IDictionary<String,Object>) DeadLetterAsync(Guid, IDictionary<String,Object>) Inherited from MessageReceiver
DeadLetterAsync(Guid, String, String) DeadLetterAsync(Guid, String, String) Inherited from MessageReceiver
Defer(Guid) Defer(Guid) Inherited from MessageReceiver
Defer(Guid, IDictionary<String,Object>) Defer(Guid, IDictionary<String,Object>) Inherited from MessageReceiver
DeferAsync(Guid) DeferAsync(Guid) Inherited from MessageReceiver
DeferAsync(Guid, IDictionary<String,Object>) DeferAsync(Guid, IDictionary<String,Object>) Inherited from MessageReceiver
Fault() Fault() Inherited from ClientEntity
GetLockToken(BrokeredMessage) GetLockToken(BrokeredMessage) Inherited from MessageReceiver
GetLockTokens(IEnumerable<BrokeredMessage>) GetLockTokens(IEnumerable<BrokeredMessage>) Inherited from MessageReceiver
GetProperty<T>() GetProperty<T>() Inherited from MessageReceiver
GetState() GetState()

Gets the state of the message session.

GetStateAsync() GetStateAsync()

Asynchronously gets the state of the message session.

OnAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan) OnAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan)

Abandons a peek locked message.

OnAbort() OnAbort()

Aborts the message session.

OnBeginAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object) OnBeginAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object)

Executes the begin abandon action.

OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close the communication object for the message session.

OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<Byte>>, Boolean, TimeSpan, AsyncCallback, Object) OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<Byte>>, Boolean, TimeSpan, AsyncCallback, Object)

Executes upon calling the OnComplete or BeginComplete operation.

OnBeginComplete(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object) OnBeginComplete(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object)

Executes upon calling the OnComplete or BeginComplete operation.

OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, Boolean, TimeSpan, AsyncCallback, Object) OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, Boolean, TimeSpan, AsyncCallback, Object)

Executes the begin move to dead letter queue action.

OnBeginDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object) OnBeginDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object)

Executes the begin defer action.

OnBeginGetState(TrackingContext, TimeSpan, AsyncCallback, Object) OnBeginGetState(TrackingContext, TimeSpan, AsyncCallback, Object)

Executes the begin get state action.

OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object)

Executes upon calling the OnOpen operation of the message receiver.

OnBeginPeek(TrackingContext, Int64, Int32, TimeSpan, AsyncCallback, Object) OnBeginPeek(TrackingContext, Int64, Int32, TimeSpan, AsyncCallback, Object)

Executes upon calling the OnPeek or BeginPeek operation.

OnBeginRenewLock(TrackingContext, TimeSpan, AsyncCallback, Object) OnBeginRenewLock(TrackingContext, TimeSpan, AsyncCallback, Object)

Executes upon calling the RenewLock or BeginRenewLock operation.

OnBeginRenewMessageLocks(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object) OnBeginRenewMessageLocks(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object)

Executes upon calling the OnBegin operation for lock messages.

OnBeginSetState(TrackingContext, Stream, TimeSpan, AsyncCallback, Object) OnBeginSetState(TrackingContext, Stream, TimeSpan, AsyncCallback, Object)

Executes the begin set state action.

OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object) OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object)

Executes the begin try receive action.

OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object) OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)

Executes the begin try receive action.

OnBeginTryReceive2(TrackingContext, Int32, TimeSpan, AsyncCallback, Object) OnBeginTryReceive2(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)

Executes the begin try receive action.

OnBeginTryReceiveEventData(TrackingContext, Int32, TimeSpan, AsyncCallback, Object) OnBeginTryReceiveEventData(TrackingContext, Int32, TimeSpan, AsyncCallback, Object) Inherited from MessageReceiver
OnClose(TimeSpan) OnClose(TimeSpan) Inherited from ClientEntity
OnClosed() OnClosed() Inherited from ClientEntity
OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan) OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan)

Completes a peek locked message.

OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, TimeSpan) OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, TimeSpan)

Moves a message to the dead letter queue.

OnDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan) OnDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan)

Defers a message.

OnEndAbandon(IAsyncResult) OnEndAbandon(IAsyncResult)

Ends an asynchronous operation to abandon the message and relinquish its lock.

OnEndClose(IAsyncResult) OnEndClose(IAsyncResult)

Ends an asynchronous operation to close the communication object for the message session.

OnEndComplete(IAsyncResult) OnEndComplete(IAsyncResult)

Executes the end complete operation of the message receiver.

OnEndDeadLetter(IAsyncResult) OnEndDeadLetter(IAsyncResult)

Executes the end deadletter operation of the message receiver.

OnEndDefer(IAsyncResult) OnEndDefer(IAsyncResult)

Executes the end defer operation of the message receiver.

OnEndGetState(IAsyncResult) OnEndGetState(IAsyncResult)

Executes upon calling the OnGetState or EndGetState operation.

OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult)

Ends the asynchronous operation to open a communication object for the message session.

OnEndPeek(IAsyncResult) OnEndPeek(IAsyncResult)

Executes upon calling the EndPeek operation.

OnEndRenewLock(IAsyncResult) OnEndRenewLock(IAsyncResult)

Executes the EndRenewLock operation of the message receiver.

OnEndRenewMessageLocks(IAsyncResult) OnEndRenewMessageLocks(IAsyncResult)

Executes the EndRenew action for message locks.

OnEndSetState(IAsyncResult) OnEndSetState(IAsyncResult)

Ends the asynchronous operation to set the state of the message session.

OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>) OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>)

Executes the end try receive operation of the message receiver.

OnEndTryReceive2(IAsyncResult, IEnumerable<BrokeredMessage>) OnEndTryReceive2(IAsyncResult, IEnumerable<BrokeredMessage>)

Executes the end try receive operation of the message receiver.

OnEndTryReceiveEventData(IAsyncResult, IEnumerable<EventData>) OnEndTryReceiveEventData(IAsyncResult, IEnumerable<EventData>) Inherited from MessageReceiver
OnFaulted() OnFaulted() Inherited from ClientEntity
OnGetState(TrackingContext, TimeSpan) OnGetState(TrackingContext, TimeSpan)

Executes the get state action.

OnMessage(Action<BrokeredMessage>, OnMessageOptions) OnMessage(Action<BrokeredMessage>, OnMessageOptions) Inherited from MessageReceiver
OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions) OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions) Inherited from MessageReceiver
OnOpen(TimeSpan) OnOpen(TimeSpan) Inherited from ClientEntity
OnOpened() OnOpened() Inherited from ClientEntity
OnPeek(TrackingContext, Int64, Int32, TimeSpan) OnPeek(TrackingContext, Int64, Int32, TimeSpan) Inherited from MessageReceiver
OnRenewLock(TrackingContext, TimeSpan) OnRenewLock(TrackingContext, TimeSpan)

Executes the RenewLock action for message locks.

OnRenewMessageLocks(TrackingContext, IEnumerable<Guid>, TimeSpan) OnRenewMessageLocks(TrackingContext, IEnumerable<Guid>, TimeSpan) Inherited from MessageReceiver
OnSetState(TrackingContext, Stream, TimeSpan) OnSetState(TrackingContext, Stream, TimeSpan)

Executes the set state action.

OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>) OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>)

Executes the try receive action.

OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>) OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>)

Executes the try receive action.

Peek() Peek() Inherited from MessageReceiver
Peek(Int64) Peek(Int64) Inherited from MessageReceiver
PeekAsync() PeekAsync() Inherited from MessageReceiver
PeekAsync(Int64) PeekAsync(Int64) Inherited from MessageReceiver
PeekBatch(Int32) PeekBatch(Int32) Inherited from MessageReceiver
PeekBatch(Int64, Int32) PeekBatch(Int64, Int32) Inherited from MessageReceiver
PeekBatchAsync(Int32) PeekBatchAsync(Int32) Inherited from MessageReceiver
PeekBatchAsync(Int64, Int32) PeekBatchAsync(Int64, Int32) Inherited from MessageReceiver
ProcessException(Exception) ProcessException(Exception)
Receive() Receive() Inherited from MessageReceiver
Receive(Int64) Receive(Int64) Inherited from MessageReceiver
Receive(TimeSpan) Receive(TimeSpan) Inherited from MessageReceiver
ReceiveAsync() ReceiveAsync() Inherited from MessageReceiver
ReceiveAsync(Int64) ReceiveAsync(Int64) Inherited from MessageReceiver
ReceiveAsync(TimeSpan) ReceiveAsync(TimeSpan) Inherited from MessageReceiver
ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>) Inherited from MessageReceiver
ReceiveBatch(Int32) ReceiveBatch(Int32) Inherited from MessageReceiver
ReceiveBatch(Int32, TimeSpan) ReceiveBatch(Int32, TimeSpan) Inherited from MessageReceiver
ReceiveBatchAsync(IEnumerable<Int64>) ReceiveBatchAsync(IEnumerable<Int64>) Inherited from MessageReceiver
ReceiveBatchAsync(Int32) ReceiveBatchAsync(Int32) Inherited from MessageReceiver
ReceiveBatchAsync(Int32, TimeSpan) ReceiveBatchAsync(Int32, TimeSpan) Inherited from MessageReceiver
RenewLock() RenewLock()

Specifies the time period within which the host renews its lock on a message.

RenewLockAsync() RenewLockAsync()

Specifies the time period within which the host renews its lock on a message.

SetState(Stream) SetState(Stream)

Sets the state of the message session.

SetStateAsync(Stream) SetStateAsync(Stream)

Asynchronously sets the state of the message session.

ThrowIfClosed() ThrowIfClosed() Inherited from ClientEntity
ThrowIfDisposed() ThrowIfDisposed() Inherited from ClientEntity
ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() Inherited from ClientEntity
ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() Inherited from ClientEntity
ThrowIfFaulted() ThrowIfFaulted() Inherited from ClientEntity

Extension Methods

IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to