SALES: 1-800-867-1380
Expand Minimize

MessageReceiver Methods

The MessageReceiver type exposes the following members.

  Name Description
Public method Abandon(Guid) Discards the message and relinquishes the message lock ownership.
Public method Abandon(Guid, IDictionary<String, Object>) Discards the message and relinquishes the message lock ownership.
Public method AbandonAsync(Guid) Asynchronously discards the message and relinquishes the message lock ownership.
Public method AbandonAsync(Guid, IDictionary<String, Object>) Asynchronously discards the message and relinquishes the message lock ownership.
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.
Public method BeginAbandon(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to abandon the message and relinquish its lock.
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.
Public method BeginCompleteBatch Begins an asynchronous operation to complete a message batching.
Public method BeginDeadLetter(Guid, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue.
Public method BeginDeadLetter(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue.
Public method BeginDeadLetter(Guid, String, String, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue.
Public method BeginDefer(Guid, AsyncCallback, Object) Begins an asynchronous operation to suspend receipt of a message.
Public method BeginDefer(Guid, IDictionary<String, Object>, AsyncCallback, Object) Begins an asynchronous operation to suspend receipt of a message.
Public method BeginPeek(AsyncCallback, Object) Begins an operation to peek a message.
Public method BeginPeek(Int64, AsyncCallback, Object) Begins an operation to peek a message.
Public method BeginPeekBatch(Int32, AsyncCallback, Object) Begins an operation to peek a batch of message.
Public method BeginPeekBatch(Int64, Int32, AsyncCallback, Object) Begins an operation to peek a batch of message.
Public method BeginReceive(AsyncCallback, Object) Begins an asynchronous operation to receive a message.
Public method BeginReceive(Int64, AsyncCallback, Object) Begins an asynchronous operation to receive a message.
Public method BeginReceive(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a message.
Public method BeginReceiveBatch(IEnumerable<Int64>, AsyncCallback, Object) Begins an asynchronous operation to receive a batch of message.
Public method BeginReceiveBatch(Int32, AsyncCallback, Object) Begins an asynchronous operation to receive a batch of message.
Public method BeginReceiveBatch(Int32, TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a batch of message.
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.
Public method CompleteAsync Asynchronously completes the receive operation on a message.
Public method CompleteBatch Completes the receive operation on a batch of message.
Public method CompleteBatchAsync Asynchronously completes the receive operation on a batch of message.
Public method DeadLetter(Guid) Moves the undelivered message to the dead letter queue.
Public method DeadLetter(Guid, IDictionary<String, Object>) Moves the undelivered message to the dead letter queue.
Public method DeadLetter(Guid, String, String) Moves the undelivered message to the dead letter queue.
Public method DeadLetterAsync(Guid) Asynchronously moves the undelivered message to the dead letter queue.
Public method DeadLetterAsync(Guid, IDictionary<String, Object>) Asynchronously moves the undelivered message to the dead letter queue.
Public method DeadLetterAsync(Guid, String, String) Asynchronously moves the undelivered message to the dead letter queue.
Public method Defer(Guid) Indicates that the receiver wants to defer the processing for the message.
Public method Defer(Guid, IDictionary<String, Object>) Indicates that the receiver wants to defer the processing for the message.
Public method DeferAsync(Guid) Asynchronously defer the processing of the message.
Public method DeferAsync(Guid, IDictionary<String, Object>) Asynchronously defer the processing of the message.
Public method EndAbandon Ends the asynchronous operation to abandon the message and relinquish its lock.
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.
Public method EndCompleteBatch Ends the asynchronous operation to complete receipt of a batch message.
Public method EndDeadLetter Ends an asynchronous operation to move the message to the dead letter queue.
Public method EndDefer Ends an asynchronous operation to defer receipt of a message.
Public method EndPeek Ends an asynchronous operation to peek a message.
Public method EndPeekBatch Ends an asynchronous operation to peek a batch of message.
Public method EndReceive Ends an asynchronous operation to receive a message.
Public method EndReceiveBatch Ends an asynchronous operation to receive a batch of message.
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 Static member GetLockToken Gets the lock token bound to the message.
Protected method Static member GetLockTokens Gets the collection of lock tokens from the specified collection of messages.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnAbandon Executes upon calling the Abandon operation.
Protected method OnAbort (Inherited from ClientEntity.)
Protected method OnBeginAbandon Executes upon calling the OnAbandon or BeginAbandon operation.
Protected method OnBeginClose (Inherited from ClientEntity.)
Protected method 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.
Protected method OnBeginDeadLetter Executes upon calling the OnDeadLetter or BeginDeadLetter operation.
Protected method OnBeginDefer Executes upon calling the OnDefer or BeginDefer operation.
Protected method OnBeginOpen (Inherited from ClientEntity.)
Protected method OnBeginPeek Executes upon calling the BeginPeek operation.
Protected method OnBeginRenewMessageLocks Executes upon calling the OnBegin operation for lock messages.
Protected method OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object) Executes upon calling the OnTryReceive or BeginTryReceive operation.
Protected method OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object) Executes upon calling the OnTryReceive or BeginTryReceive operation.
Protected method OnBeginTryReceive2 Executes upon calling the OnTryReceive or BeginTryReceive operation.
Protected method OnBeginTryReceiveEventData Executes upon calling the OnTryReceive or BeginTryReceive operation for the event data.
Protected method OnClose (Inherited from ClientEntity.)
Protected method OnClosed (Inherited from ClientEntity.)
Protected method OnComplete Executes upon calling the Complete operation.
Protected method OnDeadLetter Executes upon calling the DeadLetter operation.
Protected method OnDefer Executes upon calling the Defer operation.
Protected method OnEndAbandon Executes the end abandon action.
Protected method OnEndClose (Inherited from ClientEntity.)
Protected method OnEndComplete Executes the end complete action.
Protected method OnEndDeadLetter Executes the end move to dead letter queue action.
Protected method OnEndDefer Executes the end defer action.
Protected method OnEndOpen (Inherited from ClientEntity.)
Protected method OnEndPeek Executes the EndPeek operation.
Protected method OnEndRenewMessageLocks Executes the EndRenew action for message locks.
Protected method OnEndTryReceive Executes the end try receive action.
Protected method OnEndTryReceive2 Executes the end try receive action.
Protected method OnEndTryReceiveEventData Executes the EndTryReceive action for the event data.
Protected method OnFaulted (Inherited from ClientEntity.)
Public method OnMessage Processes a message in an event-driven message pump.
Public method OnMessageAsync Asynchronously processes a message in an event-driven message pump.
Protected method OnOpen (Inherited from ClientEntity.)
Protected method OnOpened (Inherited from ClientEntity.)
Protected method OnPeek Executes upon calling the Peek operation.
Protected method OnRenewMessageLocks Executes the Renew action for lock messages.
Protected method OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>) Executes upon calling the TryReceive operation.
Protected method OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>) Executes upon calling the TryReceive operation.
Public method Peek() Reads the next message without changing the state of the receiver or the message source.
Public method Peek(Int64) Reads the next message without changing the state of the receiver or the message source.
Public method PeekAsync() Asynchronously reads the next message without changing the state of the receiver or the message source.
Public method PeekAsync(Int64) Asynchronously reads the next message without changing the state of the receiver or the message source.
Public method PeekBatch(Int32) Reads the next batch of message without changing the state of the receiver or the message source.
Public method PeekBatch(Int64, Int32) Reads the next batch of message without changing the state of the receiver or the message source.
Public method PeekBatchAsync(Int32) Asynchronously reads the next batch of message without changing the state of the receiver or the message source.
Public method PeekBatchAsync(Int64, Int32) Asynchronously reads the next batch of message without changing the state of the receiver or the message source.
Public method Receive() Receives a BrokeredMessage from the current queue or topic.
Public method Receive(Int64) Receives a message from the current queue or topic.
Public method Receive(TimeSpan) Receives a BrokeredMessage from the current queue or topic.
Public method ReceiveAsync() Asynchronously receives a message from the current queue or topic.
Public method ReceiveAsync(Int64) Asynchronously receives a message from the current queue or topic.
Public method ReceiveAsync(TimeSpan) Asynchronously receives a message from the current queue or topic.
Public method ReceiveBatch(IEnumerable<Int64>) Receives a batch of messages.
Public method ReceiveBatch(Int32) Receives a batch of messages.
Public method ReceiveBatch(Int32, TimeSpan) Receives a batch of messages.
Public method ReceiveBatchAsync(IEnumerable<Int64>) Asynchronously receives a batch of messages.
Public method ReceiveBatchAsync(Int32) Asynchronously receives a batch of messages.
Public method ReceiveBatchAsync(Int32, TimeSpan) Asynchronously receives a batch of messages.
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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft