Home Library Learn Downloads Support Community
Sign in | United States - English | |
0 out of 1 rated this helpful Rate this topic

MessageReceiver Class

Receives messages from the message container and acknowledges them. . Although you can use the QueueClient class to send and receive messages without creating a MessageReceiver object, you can also use MessageSender and MessageReceiver to create a sender and receiver on an entity without knowing whether it is a topic or a queue.

System.Object
  Microsoft.ServiceBus.Messaging.MessageClientEntity
    Microsoft.ServiceBus.Messaging.MessageReceiver
      Microsoft.ServiceBus.Messaging.MessageSession

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
C#
C++
F#
JScript
VB
Copy 
public abstract class MessageReceiver : MessageClientEntity

The MessageReceiver type exposes the following members.

  Name Description
Public property BatchFlushInterval Gets the batch flush interval.
Protected property BatchingEnabled Gets a value indicating whether the batching is enabled.
Public property IsClosed Gets or sets a value that indicates whether the message client entity is closed. (Inherited from MessageClientEntity.)
Public property Mode Gets the message receive mode.
Public property Path Gets the path of the queue or topic, relative to the MessagingFactory base address.
Public property PrefetchCount Gets or sets the number of messages that the message receiver can simultaneously request.
Top
  Name Description
Public method Abandon Discards the message and relinquishes the message lock ownership.
Public method Abort Aborts the message client entity and puts its status into a closing state. (Inherited from MessageClientEntity.)
Public method BeginAbandon 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 BeginDeadLetter(Guid, 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 Begins an asynchronous operation to suspend receipt of a 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 Close Closes the message client entity and puts its status into a closed state. (Inherited from MessageClientEntity.)
Public method Complete Completes the receive operation on a message.
Public method DeadLetter(Guid) 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 Defer Indicates that the receiver wants to defer the processing for 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 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 EndReceive Ends an asynchronous operation to receive a message.
Public method Equals (Inherited from Object.)
Protected method Fault Puts the message client entity into a faulted state. (Inherited from MessageClientEntity.)
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 Executes upon calling the Abort operation. (Inherited from MessageClientEntity.)
Protected method OnBeginAbandon Executes upon calling the OnAbandon or BeginAbandon operation.
Protected method OnBeginClose Executes upon calling the BeginClose operation. (Inherited from MessageClientEntity.)
Protected method OnBeginComplete 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 Executes upon calling the operation to begin to open the message client entity. (Inherited from MessageClientEntity.)
Protected method OnBeginTryReceive(TrackingContext, IEnumerable(Of 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 OnClose Executes upon calling the Close operation. (Inherited from MessageClientEntity.)
Protected method OnClosed Occurs when the message client entity is transitioned into a closing state. (Inherited from MessageClientEntity.)
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 Executes upon calling the EndClose operation. (Inherited from MessageClientEntity.)
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 Executes upon calling the operation to end to open the message client entity. (Inherited from MessageClientEntity.)
Protected method OnEndTryReceive Executes the end try receive action.
Protected method OnFaulted Executes upon calling the Fault operation. (Inherited from MessageClientEntity.)
Protected method OnOpen Executes upon calling the operation to open the message client entity. (Inherited from MessageClientEntity.)
Protected method OnOpened Executes when the message client entity is opened. (Inherited from MessageClientEntity.)
Protected method OnTryReceive(TrackingContext, IEnumerable(Of Int64), TimeSpan, IEnumerable(Of BrokeredMessage)) Executes upon calling the TryReceive operation.
Protected method OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable(Of BrokeredMessage)) Executes upon calling the TryReceive operation.
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.
Protected method ThrowIfClosed Throws an exception if the message client entity is closed. (Inherited from MessageClientEntity.)
Protected method ThrowIfDisposed Throws an exception if the message client entity is disposed. (Inherited from MessageClientEntity.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the client is disposed or immutable. (Inherited from MessageClientEntity.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the client is disposed or not open. (Inherited from MessageClientEntity.)
Protected method ThrowIfFaulted Throws an exception if the client is faulted. (Inherited from MessageClientEntity.)
Public method ToString (Inherited from Object.)
Top

Note that the default message receive mode is PeekLock, which ensures reliable message receiving.

The following example receives a message from the queue created in the MessageSender example:

C#
Copy 
Uri serviceUri = ServiceBusEnvironment.CreateServiceUri("sb", ServiceNamespace, string.Empty); 

MessagingFactory factory = MessagingFactory.Create(serviceUri, credentials); 

MessageReceiver myMessageReceiver = factory.CreateMessageReceiver(queueName);

BrokeredMessage message;
while ((message = myMessageReceiver.Receive(new TimeSpan(hours: 0, minutes: 0, seconds: 5))) != null)
{
    Console.WriteLine(
    string.Format(
    "Message received: Id = {0}, Body = {1}", message.MessageId, message.GetBody<string>()));
    message.Complete();
}
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)