Export (0) Print
Expand All
Expand Minimize

MessageSession Methods

The MessageSession type exposes the following members.

  Name Description
Public method Abandon(Guid) Discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public method Abandon(Guid, IDictionary<String, Object>) Discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public method AbandonAsync(Guid) Asynchronously discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public method AbandonAsync(Guid, IDictionary<String, Object>) Asynchronously discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public method Abort Performs abort functionality on the messaging entity. (Inherited from ClientEntity.)
Public method BeginAbandon(Guid, AsyncCallback, Object) Begins an asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public method BeginAbandon(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public method BeginClose Begins an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public method BeginComplete Begins an asynchronous operation to complete receipt of a message. (Inherited from MessageReceiver.)
Public method BeginCompleteBatch Begins an asynchronous operation to complete a message batching. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(Guid, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(Guid, String, String, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public method BeginDefer(Guid, AsyncCallback, Object) Begins an asynchronous operation to suspend receipt of a message. (Inherited from MessageReceiver.)
Public method BeginDefer(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to suspend receipt of a message. (Inherited from MessageReceiver.)
Public method BeginGetState Begins an asynchronous operation to set the state of the message session.
Public method BeginPeek(AsyncCallback, Object) Begins an operation to peek a message. (Inherited from MessageReceiver.)
Public method BeginPeek(Int64, AsyncCallback, Object) Begins an operation to peek a message. (Inherited from MessageReceiver.)
Public method BeginPeekBatch(Int32, AsyncCallback, Object) Begins an operation to peek a batch of message. (Inherited from MessageReceiver.)
Public method BeginPeekBatch(Int64, Int32, AsyncCallback, Object) Begins an operation to peek a batch of message. (Inherited from MessageReceiver.)
Public method BeginReceive(AsyncCallback, Object) Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method BeginReceive(Int64, AsyncCallback, Object) Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method BeginReceive(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method BeginReceiveBatch(IEnumerable<Int64>, AsyncCallback, Object) Begins an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public method BeginReceiveBatch(Int32, AsyncCallback, Object) Begins an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public method BeginReceiveBatch(Int32, TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public method BeginRenewLock Starts the renewal of lock of the message session.
Public method BeginSetState Begins an asynchronous operation to set the state of the message session.
Public method Close Sends a cleanup message to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity.)
Public method CloseAsync Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity.)
Public method Complete Completes the receive operation on a message. (Inherited from MessageReceiver.)
Public method CompleteAsync Asynchronously completes the receive operation on a message. (Inherited from MessageReceiver.)
Public method CompleteBatch Completes the receive operation on a batch of message. (Inherited from MessageReceiver.)
Public method CompleteBatchAsync Asynchronously completes the receive operation on a batch of message. (Inherited from MessageReceiver.)
Public method DeadLetter(Guid) Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method DeadLetter(Guid, IDictionary<String, Object>) Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method DeadLetter(Guid, String, String) Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method DeadLetterAsync(Guid) Asynchronously moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method DeadLetterAsync(Guid, IDictionary<String, Object>) Asynchronously moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method DeadLetterAsync(Guid, String, String) Asynchronously moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method Defer(Guid) Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.)
Public method Defer(Guid, IDictionary<String, Object>) Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.)
Public method DeferAsync(Guid) Asynchronously defer the processing of the message. (Inherited from MessageReceiver.)
Public method DeferAsync(Guid, IDictionary<String, Object>) Asynchronously defer the processing of the message. (Inherited from MessageReceiver.)
Public method EndAbandon Ends the asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public method EndClose Finishes an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public method EndComplete Ends the asynchronous operation to complete receipt of a message. (Inherited from MessageReceiver.)
Public method EndCompleteBatch Ends the asynchronous operation to complete receipt of a batch message. (Inherited from MessageReceiver.)
Public method EndDeadLetter Ends an asynchronous operation to move the message to the dead letter queue. (Inherited from MessageReceiver.)
Public method EndDefer Ends an asynchronous operation to defer receipt of a message. (Inherited from MessageReceiver.)
Public method EndGetState Ends an asynchronous operation to get the state of the message session.
Public method EndPeek Ends an asynchronous operation to peek a message. (Inherited from MessageReceiver.)
Public method EndPeekBatch Ends an asynchronous operation to peek a batch of message. (Inherited from MessageReceiver.)
Public method EndReceive Ends an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method EndReceiveBatch Ends an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public method EndRenewLock Starts the renewal of lock of the message session.
Public method EndSetState Ends an asynchronous operation to set the state of the message session.
Public method Equals (Inherited from Object.)
Protected method Fault For internal use only. Do not inherit from this class. (Inherited from ClientEntity.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Protected method GetProperty<T> (Inherited from MessageReceiver.)
Public method GetState Gets the state of the message session.
Public method GetStateAsync Asynchronously gets the state of the message session.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnAbandon Executes upon calling the Abandon operation. (Overrides MessageReceiver.OnAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String, Object>, TimeSpan).)
Protected method OnAbort Aborts the message session. (Overrides ClientEntity.OnAbort().)
Protected method OnBeginAbandon Executes upon calling the OnAbandon or BeginAbandon operation. (Overrides MessageReceiver.OnBeginAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String, Object>, Boolean, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginClose Begins an asynchronous operation to close the communication object for the message session. (Overrides ClientEntity.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<Byte>>, Boolean, TimeSpan, AsyncCallback, Object) Executes upon calling the OnComplete or BeginComplete operation. (Overrides MessageReceiver.OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<Byte>>, Boolean, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginComplete(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object) Executes upon calling the OnComplete or BeginComplete operation. (Overrides MessageReceiver.OnBeginComplete(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginDeadLetter Executes upon calling the OnDeadLetter or BeginDeadLetter operation. (Overrides MessageReceiver.OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String, Object>, String, String, Boolean, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginDefer Executes upon calling the OnDefer or BeginDefer operation. (Overrides MessageReceiver.OnBeginDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String, Object>, Boolean, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginGetState Executes upon calling the OnGetState or BeginGetState operation.
Protected method OnBeginOpen Executes upon calling the OnOpen operation of the message receiver. (Overrides ClientEntity.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginPeek Executes upon calling the OnPeek or BeginPeek operation. (Overrides MessageReceiver.OnBeginPeek(TrackingContext, Int64, Int32, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginRenewLock Executes upon calling the RenewLock or BeginRenewLock operation.
Protected method OnBeginRenewMessageLocks Executes upon calling the OnBegin operation for lock messages. (Overrides MessageReceiver.OnBeginRenewMessageLocks(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginSetState Executes upon calling the OnSetState or BeginSetState operation.
Protected method OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object) Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver. (Overrides MessageReceiver.OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object) Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver. (Overrides MessageReceiver.OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginTryReceive2 Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver. (Overrides MessageReceiver.OnBeginTryReceive2(TrackingContext, Int32, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginTryReceiveEventData Executes upon calling the OnTryReceive or BeginTryReceive operation for the event data. (Inherited from MessageReceiver.)
Protected method OnClose (Inherited from ClientEntity.)
Protected method OnClosed (Inherited from ClientEntity.)
Protected method OnComplete Completes the message receive operation. (Overrides MessageReceiver.OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan).)
Protected method OnDeadLetter Executes upon calling the DeadLetter operation. (Overrides MessageReceiver.OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String, Object>, String, String, TimeSpan).)
Protected method OnDefer Executes upon calling the Defer operation. (Overrides MessageReceiver.OnDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String, Object>, TimeSpan).)
Protected method OnEndAbandon Ends an asynchronous operation to abandon the message and relinquish its lock. (Overrides MessageReceiver.OnEndAbandon(IAsyncResult).)
Protected method OnEndClose Ends an asynchronous operation to close the communication object for the message session. (Overrides ClientEntity.OnEndClose(IAsyncResult).)
Protected method OnEndComplete Executes the end complete operation of the message receiver. (Overrides MessageReceiver.OnEndComplete(IAsyncResult).)
Protected method OnEndDeadLetter Executes the end deadletter operation of the message receiver. (Overrides MessageReceiver.OnEndDeadLetter(IAsyncResult).)
Protected method OnEndDefer Executes the end defer operation of the message receiver. (Overrides MessageReceiver.OnEndDefer(IAsyncResult).)
Protected method OnEndGetState Executes upon calling the OnGetState or EndGetState operation.
Protected method OnEndOpen Ends the asynchronous operation to open a communication object for the message session. (Overrides ClientEntity.OnEndOpen(IAsyncResult).)
Protected method OnEndPeek Executes upon calling the EndPeek operation. (Overrides MessageReceiver.OnEndPeek(IAsyncResult).)
Protected method OnEndRenewLock Executes the EndRenewLock operation of the message receiver.
Protected method OnEndRenewMessageLocks Executes the EndRenew action for message locks. (Overrides MessageReceiver.OnEndRenewMessageLocks(IAsyncResult).)
Protected method OnEndSetState Ends the asynchronous operation to set the state of the message session.
Protected method OnEndTryReceive Executes the end try receive operation of the message receiver. (Overrides MessageReceiver.OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>).)
Protected method OnEndTryReceive2 Executes the end try receive operation of the message receiver. (Overrides MessageReceiver.OnEndTryReceive2(IAsyncResult, IEnumerable<BrokeredMessage>).)
Protected method OnEndTryReceiveEventData Executes the EndTryReceive action for the event data. (Inherited from MessageReceiver.)
Protected method OnFaulted (Inherited from ClientEntity.)
Protected method OnGetState Executes upon calling the GetState operation.
Public method OnMessage Processes a message in an event-driven message pump. (Inherited from MessageReceiver.)
Public method OnMessageAsync Asynchronously processes a message in an event-driven message pump. (Inherited from MessageReceiver.)
Protected method OnOpen (Inherited from ClientEntity.)
Protected method OnOpened (Inherited from ClientEntity.)
Protected method OnPeek Executes upon calling the Peek operation. (Inherited from MessageReceiver.)
Protected method OnRenewLock Executes the RenewLock action for message locks.
Protected method OnRenewMessageLocks Executes the Renew action for lock messages. (Inherited from MessageReceiver.)
Protected method OnSetState Executes upon calling the SetState operation.
Protected method OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>) Attempts a message receive operation. (Overrides MessageReceiver.OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>).)
Protected method OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>) Attempts a message receive operation. (Overrides MessageReceiver.OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>).)
Public method Peek() Reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method Peek(Int64) Reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method PeekAsync() Asynchronously reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method PeekAsync(Int64) Asynchronously reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method PeekBatch(Int32) Reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method PeekBatch(Int64, Int32) Reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method PeekBatchAsync(Int32) Asynchronously reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method PeekBatchAsync(Int64, Int32) Asynchronously reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public method Receive() Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(Int64) Receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(TimeSpan) Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public method ReceiveAsync() Asynchronously receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public method ReceiveAsync(Int64) Asynchronously receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public method ReceiveAsync(TimeSpan) Asynchronously receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public method ReceiveBatch(IEnumerable<Int64>) Receives a batch of messages. (Inherited from MessageReceiver.)
Public method ReceiveBatch(Int32) Receives a batch of messages. (Inherited from MessageReceiver.)
Public method ReceiveBatch(Int32, TimeSpan) Receives a batch of messages. (Inherited from MessageReceiver.)
Public method ReceiveBatchAsync(IEnumerable<Int64>) Asynchronously receives a batch of messages. (Inherited from MessageReceiver.)
Public method ReceiveBatchAsync(Int32) Asynchronously receives a batch of messages. (Inherited from MessageReceiver.)
Public method ReceiveBatchAsync(Int32, TimeSpan) Asynchronously receives a batch of messages. (Inherited from MessageReceiver.)
Public method RenewLock Specifies the time period within which the host renews its lock on a message.
Public method RenewLockAsync Specifies the time period within which the host renews its lock on a message.
Public method SetState Sets the state of the message session.
Public method SetStateAsync Asynchronously sets the state of the message session.
Protected method ThrowIfClosed (Inherited from ClientEntity.)
Protected method ThrowIfDisposed (Inherited from ClientEntity.)
Protected method ThrowIfDisposedOrImmutable (Inherited from ClientEntity.)
Protected method ThrowIfDisposedOrNotOpen (Inherited from ClientEntity.)
Protected method ThrowIfFaulted (Inherited from ClientEntity.)
Public method ToString (Inherited from Object.)
Top

Community Additions

ADD
Show:
© 2015 Microsoft