Class MessageSession

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

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

public abstract class MessageSession : MessageReceiver

Inheritance

object

ClientEntity

MessageReceiver

MessageSession

Inherited Members

MessageReceiver.OnMessage(Action<BrokeredMessage>, OnMessageOptions)

MessageReceiver.OnMessageAsync(Func<BrokeredMessage, Task>, OnMessageOptions)

MessageReceiver.Abandon(Guid)

MessageReceiver.Abandon(Guid, IDictionary<string, object>)

MessageReceiver.AbandonAsync(Guid)

MessageReceiver.AbandonAsync(Guid, IDictionary<string, object>)

MessageReceiver.Complete(Guid)

MessageReceiver.CompleteAsync(Guid)

MessageReceiver.CompleteBatch(IEnumerable<Guid>)

MessageReceiver.CompleteBatchAsync(IEnumerable<Guid>)

MessageReceiver.Defer(Guid)

MessageReceiver.Defer(Guid, IDictionary<string, object>)

MessageReceiver.DeferAsync(Guid)

MessageReceiver.DeferAsync(Guid, IDictionary<string, object>)

MessageReceiver.Receive()

MessageReceiver.ReceiveBatch(int)

MessageReceiver.Receive(TimeSpan)

MessageReceiver.ReceiveBatch(int, TimeSpan)

MessageReceiver.Receive(long)

MessageReceiver.ReceiveAsync()

MessageReceiver.ReceiveAsync(TimeSpan)

MessageReceiver.ReceiveAsync(long)

MessageReceiver.ReceiveBatch(IEnumerable<long>)

MessageReceiver.ReceiveBatchAsync(int)

MessageReceiver.ReceiveBatchAsync(int, TimeSpan)

MessageReceiver.ReceiveBatchAsync(IEnumerable<long>)

MessageReceiver.DeadLetter(Guid, IDictionary<string, object>)

MessageReceiver.DeadLetter(Guid, string, string)

MessageReceiver.DeadLetter(Guid)

MessageReceiver.DeadLetterAsync(Guid)

MessageReceiver.DeadLetterAsync(Guid, IDictionary<string, object>)

MessageReceiver.DeadLetterAsync(Guid, string, string)

MessageReceiver.GetLockToken(BrokeredMessage)

MessageReceiver.GetLockTokens(IEnumerable<BrokeredMessage>)

MessageReceiver.OnBeginTryReceiveEventData(TrackingContext, int, TimeSpan, AsyncCallback, object)

MessageReceiver.OnEndTryReceiveEventData(IAsyncResult, out IEnumerable<EventData>)

MessageReceiver.OnRenewMessageLocks(TrackingContext, IEnumerable<Guid>, TimeSpan)

MessageReceiver.GetProperty<T>()

MessageReceiver.Peek()

MessageReceiver.Peek(long)

MessageReceiver.PeekAsync()

MessageReceiver.PeekAsync(long)

MessageReceiver.PeekBatch(int)

MessageReceiver.PeekBatch(long, int)

MessageReceiver.PeekBatchAsync(int)

MessageReceiver.PeekBatchAsync(long, int)

MessageReceiver.OnPeek(TrackingContext, long, int, TimeSpan)

MessageReceiver.BatchFlushInterval

MessageReceiver.Mode

MessageReceiver.ReceiverStartTime

MessageReceiver.OffsetInclusive

MessageReceiver.StartOffset

MessageReceiver.BatchingEnabled

ClientEntity.Abort()

ClientEntity.Close()

ClientEntity.CloseAsync()

ClientEntity.Fault()

ClientEntity.OnOpen(TimeSpan)

ClientEntity.OnClose(TimeSpan)

ClientEntity.ThrowIfClosed()

ClientEntity.ThrowIfDisposed()

ClientEntity.ThrowIfDisposedOrNotOpen()

ClientEntity.ThrowIfFaulted()

ClientEntity.ThrowIfDisposedOrImmutable()

ClientEntity.OnOpened()

ClientEntity.OnClosed()

ClientEntity.OnFaulted()

ClientEntity.RetryPolicy

ClientEntity.IsClosed

ClientEntity.ThisLock

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

LastPeekedSequenceNumber

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

public override long LastPeekedSequenceNumber { get; }

Property Value

long

The last peeked sequence number in the session.

LockedUntilUtc

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

public DateTime LockedUntilUtc { get; protected set; }

Property Value

DateTime

The date and time for the message session to be locked.

Path

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

public override string Path { get; }

Property Value

string

A string representing the path of the queue or topic.

PrefetchCount

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

public override int PrefetchCount { get; set; }

Property Value

int

The number of messages that the message receiver can simultaneously request.

SessionId

Gets or sets the message session identifier.

public virtual string SessionId { get; protected set; }

Property Value

string

The message session identifier.

SupportsGetRuntimeEntityDescription

protected override bool SupportsGetRuntimeEntityDescription { get; }

Property Value

bool

Methods

GetState()

Gets the state of the message session.

public Stream GetState()

Returns

Stream

The stream from which the state information is persisted.

GetStateAsync()

Asynchronously gets the state of the message session.

public Task<Stream> GetStateAsync()

Returns

Task<Stream>

The stream from which the state information is persisted.

OnAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<string, object>, TimeSpan)

Executes upon calling the Abandon operation.

protected override void OnAbandon(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, IDictionary<string, object> propertiesToModify, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify IDictionary<string, object>

The properties to modify.

timeout TimeSpan

The time span the operation waits before it times out.

OnAbort()

Aborts the message session.

protected override void OnAbort()

OnBeginAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<string, object>, bool, TimeSpan, AsyncCallback, object)

Executes upon calling the OnAbandon or BeginAbandon operation.

protected override IAsyncResult OnBeginAbandon(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, IDictionary<string, object> propertiesToModify, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify IDictionary<string, object>

The properties to modify.

fromSync bool

The start of the synchronization.

timeout TimeSpan

The time span the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to get the result of the operation.

OnBeginClose(TimeSpan, AsyncCallback, object)

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

protected override IAsyncResult OnBeginClose(TimeSpan timeout, AsyncCallback callback, object state)

Parameters

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to close the communication object for the message session.

OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<byte>>, bool, TimeSpan, AsyncCallback, object)

Executes upon calling the OnComplete or BeginComplete operation.

protected override IAsyncResult OnBeginComplete(TrackingContext trackingContext, IEnumerable<ArraySegment<byte>> deliveryTags, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

deliveryTags IEnumerable<ArraySegment<byte>>

A collection of delivery tags.

fromSync bool

The start of the synchronization.

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to close the communication object for the message session.

OnBeginComplete(TrackingContext, IEnumerable<Guid>, bool, TimeSpan, AsyncCallback, object)

Executes upon calling the OnComplete or BeginComplete operation.

protected override IAsyncResult OnBeginComplete(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

fromSync bool

The start of the synchronization.

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to close the communication object for the message session.

OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<string, object>, string, string, bool, TimeSpan, AsyncCallback, object)

Executes upon calling the OnDeadLetter or BeginDeadLetter operation.

protected override IAsyncResult OnBeginDeadLetter(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, IDictionary<string, object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify IDictionary<string, object>

The properties to modify.

deadLetterReason string

The reason for deadlettering the messages.

deadLetterErrorDescription string

The error description for deadlettering the messages.

fromSync bool

The start of the synchronization.

timeout TimeSpan

The time span the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to get the state of the operation.

OnBeginDefer(TrackingContext, IEnumerable<Guid>, IDictionary<string, object>, bool, TimeSpan, AsyncCallback, object)

Executes upon calling the OnDefer or BeginDefer operation.

protected override IAsyncResult OnBeginDefer(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, IDictionary<string, object> propertiesToModify, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify IDictionary<string, object>

The properties to modify.

fromSync bool

The start of the synchronization.

timeout TimeSpan

The time span the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to suspend processing of messages.

OnBeginGetState(TrackingContext, TimeSpan, AsyncCallback, object)

Executes upon calling the OnGetState or BeginGetState operation.

protected abstract IAsyncResult OnBeginGetState(TrackingContext trackingContext, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to get the state of the message session.

OnBeginOpen(TimeSpan, AsyncCallback, object)

Executes upon calling the OnOpen operation of the message receiver.

protected override IAsyncResult OnBeginOpen(TimeSpan timeout, AsyncCallback callback, object state)

Parameters

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to open a communication object for the message session.

OnBeginPeek(TrackingContext, long, int, TimeSpan, AsyncCallback, object)

Executes upon calling the OnPeek or BeginPeek operation.

protected override IAsyncResult OnBeginPeek(TrackingContext trackingContext, long fromSequenceNumber, int messageCount, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

fromSequenceNumber long

The sequence number to peek from the session.

messageCount int

The number of message in the operation.

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to peek a communication of the message session.

OnBeginRenewLock(TrackingContext, TimeSpan, AsyncCallback, object)

Executes upon calling the RenewLock or BeginRenewLock operation.

protected abstract IAsyncResult OnBeginRenewLock(TrackingContext trackingContext, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to get the state of the operation.

OnBeginRenewMessageLocks(TrackingContext, IEnumerable<Guid>, bool, TimeSpan, AsyncCallback, object)

Executes upon calling the OnBegin operation for lock messages.

protected override IAsyncResult OnBeginRenewMessageLocks(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

fromSync bool

The start of the synchronization.

timeout TimeSpan

The time span the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to renew processing of lock messages.

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

Executes upon calling the OnSetState or BeginSetState operation.

protected abstract IAsyncResult OnBeginSetState(TrackingContext trackingContext, Stream sessionState, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

sessionState Stream

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to set the state of the message session.

OnBeginTryReceive(TrackingContext, IEnumerable<long>, TimeSpan, AsyncCallback, object)

Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver.

protected override IAsyncResult OnBeginTryReceive(TrackingContext trackingContext, IEnumerable<long> receipts, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

receipts IEnumerable<long>

The collection of unique numbers assigned to messages by the Service Bus.

timeout TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to try to receive messages.

OnBeginTryReceive(TrackingContext, int, TimeSpan, AsyncCallback, object)

Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver.

protected override IAsyncResult OnBeginTryReceive(TrackingContext trackingContext, int messageCount, TimeSpan serverWaitTime, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

messageCount int

The number of messages to try to receive.

serverWaitTime TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to try to receive messages.

OnBeginTryReceive2(TrackingContext, int, TimeSpan, AsyncCallback, object)

Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver.

protected override IAsyncResult OnBeginTryReceive2(TrackingContext trackingContext, int messageCount, TimeSpan serverWaitTime, AsyncCallback callback, object state)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

messageCount int

The number of messages to try to receive.

serverWaitTime TimeSpan

The time span interval the operation waits before it times out.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation to try to receive messages.

OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan)

Completes the message receive operation.

protected override void OnComplete(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

timeout TimeSpan

The time span interval the operation waits before it times out.

OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<string, object>, string, string, TimeSpan)

Executes upon calling the DeadLetter operation.

protected override void OnDeadLetter(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, IDictionary<string, object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify IDictionary<string, object>

The properties to modify.

deadLetterReason string

The reason for deadlettering the message.

deadLetterErrorDescription string

The error description for deadlettering the message.

timeout TimeSpan

The time span the operation waits before it times out.

OnDefer(TrackingContext, IEnumerable<Guid>, IDictionary<string, object>, TimeSpan)

Executes upon calling the Defer operation.

protected override void OnDefer(TrackingContext trackingContext, IEnumerable<Guid> lockTokens, IDictionary<string, object> propertiesToModify, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

lockTokens IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify IDictionary<string, object>

The properties to modify.

timeout TimeSpan

The time span the operation waits before it times out.

OnEndAbandon(IAsyncResult)

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

protected override void OnEndAbandon(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to abandon the messages and relinquish its lock.

OnEndClose(IAsyncResult)

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

protected override void OnEndClose(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to close the communication object for the message session.

OnEndComplete(IAsyncResult)

Executes the end complete operation of the message receiver.

protected override void OnEndComplete(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to complete receiving of messages.

OnEndDeadLetter(IAsyncResult)

Executes the end deadletter operation of the message receiver.

protected override void OnEndDeadLetter(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to move undelivered messages to the deadletter queue.

OnEndDefer(IAsyncResult)

Executes the end defer operation of the message receiver.

protected override void OnEndDefer(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to suspend processing of messages.

OnEndGetState(IAsyncResult)

Executes upon calling the OnGetState or EndGetState operation.

protected abstract Stream OnEndGetState(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to get the state of the message session.

Returns

Stream

The stream from which the state information is persisted.

OnEndOpen(IAsyncResult)

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

protected override void OnEndOpen(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to open a communication object for the message session.

OnEndPeek(IAsyncResult)

Executes upon calling the EndPeek operation.

protected override IEnumerable<BrokeredMessage> OnEndPeek(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to peek a communication of the message session.

Returns

IEnumerable<BrokeredMessage>

The list of message from the session.

OnEndRenewLock(IAsyncResult)

Executes the EndRenewLock operation of the message receiver.

protected abstract DateTime OnEndRenewLock(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to get the state of the message session.

Returns

DateTime

The date and time when the renewal of lock ends.

OnEndRenewMessageLocks(IAsyncResult)

Executes the EndRenew action for message locks.

protected override IEnumerable<DateTime> OnEndRenewMessageLocks(IAsyncResult result)

Parameters

result IAsyncResult

The result of the operation.

Returns

IEnumerable<DateTime>

An IEnumerable<T> of locked messages..

OnEndSetState(IAsyncResult)

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

protected abstract void OnEndSetState(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to set the state of the message session.

OnEndTryReceive(IAsyncResult, out IEnumerable<BrokeredMessage>)

Executes the end try receive operation of the message receiver.

protected override bool OnEndTryReceive(IAsyncResult result, out IEnumerable<BrokeredMessage> messages)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to try to receive messages.

messages IEnumerable<BrokeredMessage>

When this method returns, contains the received message collection.

Returns

bool

true if it succeeds; false if it fails.

OnEndTryReceive2(IAsyncResult, out IEnumerable<BrokeredMessage>)

Executes the end try receive operation of the message receiver.

protected override bool OnEndTryReceive2(IAsyncResult result, out IEnumerable<BrokeredMessage> messages)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous operation to try to receive messages.

messages IEnumerable<BrokeredMessage>

When this method returns, contains the received message collection.

Returns

bool

true if it succeeds; false if it fails.

OnGetState(TrackingContext, TimeSpan)

Executes upon calling the GetState operation.

protected virtual Stream OnGetState(TrackingContext trackingContext, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

timeout TimeSpan

The time span interval the get operation waits before it times out.

Returns

Stream

The stream from which the state information is persisted.

OnRenewLock(TrackingContext, TimeSpan)

Executes the RenewLock action for message locks.

protected virtual DateTime OnRenewLock(TrackingContext trackingContext, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

timeout TimeSpan

The time span interval the operation waits before it times out.

Returns

DateTime

The time span the operation waits before it times out.

OnSetState(TrackingContext, Stream, TimeSpan)

Executes upon calling the SetState operation.

protected virtual void OnSetState(TrackingContext trackingContext, Stream stream, TimeSpan timeout)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

stream Stream

The stream to which the state information is persisted.

timeout TimeSpan

The time span interval the set operation waits before it times out.

OnTryReceive(TrackingContext, IEnumerable<long>, TimeSpan, out IEnumerable<BrokeredMessage>)

Attempts a message receive operation.

protected override bool OnTryReceive(TrackingContext trackingContext, IEnumerable<long> receipts, TimeSpan timeout, out IEnumerable<BrokeredMessage> messages)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

receipts IEnumerable<long>

The collection of unique numbers assigned to messages by the Service Bus.

timeout TimeSpan

The time span interval the operation waits before it times out.

messages IEnumerable<BrokeredMessage>

A collection of BrokeredMessage objects.

Returns

bool

true if the receive operation was successful; otherwise, false.

OnTryReceive(TrackingContext, int, TimeSpan, out IEnumerable<BrokeredMessage>)

Attempts a message receive operation.

protected override bool OnTryReceive(TrackingContext trackingContext, int messageCount, TimeSpan serverWaitTime, out IEnumerable<BrokeredMessage> messages)

Parameters

trackingContext TrackingContext

The context information associated by a transaction tracking this operation.

messageCount int

The number of messages to try to receive.

serverWaitTime TimeSpan

The time span interval the operation waits before it times out.

messages IEnumerable<BrokeredMessage>

A collection of BrokeredMessage objects.

Returns

bool

true if the receive operation was successful; otherwise, false.

RenewLock()

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

public void RenewLock()

Exceptions

MessagingException

If IsTransient is true, you can retry the operation immediately.

MessagingCommunicationException

You can retry the operation immediately.

TimeoutException

You can retry the operation immediately.

SessionLockLostException

Thrown instead of MessageLockLostException if the message is from a MessageSession.

RenewLockAsync()

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

public Task RenewLockAsync()

Returns

Task

The host that is being locked.

SetState(Stream)

Sets the state of the message session.

public void SetState(Stream sessionState)

Parameters

sessionState Stream

SetStateAsync(Stream)

Asynchronously sets the state of the message session.

public Task SetStateAsync(Stream sessionState)

Parameters

sessionState Stream

Returns

Task

The state of the message session.