MessageReceiver Clase

Definición

Espacio de nombres:

Microsoft.Azure.ServiceBus.Core

Ensamblado:

Microsoft.Azure.ServiceBus.dll

Paquete:

Microsoft.Azure.ServiceBus v5.2.0

Source:

MessageReceiver.cs

MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.

public class MessageReceiver : Microsoft.Azure.ServiceBus.ClientEntity, Microsoft.Azure.ServiceBus.Core.IMessageReceiver

type MessageReceiver = class
    inherit ClientEntity
    interface IMessageReceiver
    interface IReceiverClient
    interface IClientEntity

Public Class MessageReceiver
Inherits ClientEntity
Implements IMessageReceiver

Herencia

Object

ClientEntity

MessageReceiver

Implementaciones

IMessageReceiver IReceiverClient IClientEntity

Ejemplos

Crear un nuevo messageReceiver para recibir un mensaje de una suscripción

IMessageReceiver messageReceiver = new MessageReceiver(
    namespaceConnectionString,
    EntityNameHelper.FormatSubscriptionPath(topicName, subscriptionName),
    ReceiveMode.PeekLock);

Reciba un mensaje de la suscripción.

var message = await messageReceiver.ReceiveAsync();
await messageReceiver.CompleteAsync(message.SystemProperties.LockToken);

Comentarios

MessageReceiver proporciona funcionalidad avanzada que no se encuentra en o QueueClientSubscriptionClient. Por ejemplo, , ReceiveAsync()que permite recibir mensajes a petición, pero también requiere que renueve manualmente los bloqueos mediante RenewLockAsync(Message). Usa el protocolo AMQP para comunicarse con el servicio.

Constructores

MessageReceiver(ServiceBusConnection, String, ReceiveMode, RetryPolicy, Int32)	Crea un nuevo messageReceiver de AMQP en un determinado ServiceBusConnection
MessageReceiver(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy, Int32)	Crea un objeto MessageReceiver a partir de .ServiceBusConnectionStringBuilder
MessageReceiver(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy, Int32)	Crea un nuevo messageReceiver a partir de un punto de conexión, una ruta de acceso de entidad y un proveedor de tokens especificados.
MessageReceiver(String, String, ReceiveMode, RetryPolicy, Int32)	Crea un nuevo MessageReceiver a partir de una cadena de conexión y una ruta de acceso de entidad especificadas.

Propiedades

ClientId	Obtiene el identificador para identificar este cliente. Se puede usar para correlacionar registros y excepciones. (Heredado de ClientEntity)
IsClosedOrClosing	Devuelve true si el cliente está cerrado o cerrado. (Heredado de ClientEntity)
LastPeekedSequenceNumber	Obtiene el número de secuencia del último mensaje que se ha inspeccionado.
OperationTimeout	Duración después de la cual se expirarán las operaciones individuales.
OwnsConnection	Devuelve true si la conexión es propiedad y false si se comparte la conexión. (Heredado de ClientEntity)
Path	Ruta de acceso de la entidad para este receptor. En el caso de las colas, este será el nombre, pero para las suscripciones será la ruta de acceso.
PrefetchCount	La captura previa acelera el flujo de mensajes con el objetivo de tener un mensaje disponible para la recuperación local cuando y antes de que la aplicación solicite una mediante Receive. Establecer una captura previa de valor distinto de cero prefetchCount número de mensajes. Al establecer el valor en cero, se desactiva la captura previa. El valor predeterminado es 0.
ReceiveMode	Obtiene el ReceiveMode objeto del receptor actual.
RegisteredPlugins	Obtiene una lista de complementos registrados actualmente.
RetryPolicy	Obtiene el RetryPolicy definido en el cliente. (Heredado de ClientEntity)
ServiceBusConnection	Objeto de conexión al espacio de nombres de Service Bus.

Métodos

AbandonAsync(String, IDictionary<String,Object>)	Abandona un Message mediante un token de bloqueo. Esto hará que el mensaje vuelva a estar disponible para su procesamiento.
CloseAsync()	Cierra el cliente. Cierra las conexiones abiertas por ella. (Heredado de ClientEntity)
CompleteAsync(IEnumerable<String>)	Completa una serie de uso de Message una lista de tokens de bloqueo. Esto eliminará el mensaje del servicio.
CompleteAsync(String)	Completa un Message mediante su token de bloqueo. Esto eliminará el mensaje del servicio.
DeadLetterAsync(String, IDictionary<String,Object>)	Mueve un mensaje a la subcola de mensajes fallidos.
DeadLetterAsync(String, String, String)	Mueve un mensaje a la subcola de mensajes fallidos.
DeferAsync(String, IDictionary<String,Object>)	Indica que el receptor quiere aplazar el procesamiento del mensaje.
OnAbandonAsync(String, IDictionary<String,Object>)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnClosingAsync()	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnCompleteAsync(IEnumerable<String>)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnDeadLetterAsync(String, IDictionary<String,Object>, String, String)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnDeferAsync(String, IDictionary<String,Object>)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnMessageHandler(MessageHandlerOptions, Func<Message,CancellationToken,Task>)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnPeekAsync(Int64, Int32)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnReceiveAsync(Int32, TimeSpan)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnReceiveDeferredMessageAsync(Int64[])	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
OnRenewLockAsync(String)	MessageReceiver se puede usar para recibir mensajes de colas y suscripciones y confirmarlos.
PeekAsync()	Captura el siguiente mensaje activo sin cambiar el estado del receptor o el origen del mensaje.
PeekAsync(Int32)	Captura el siguiente lote de mensajes activos sin cambiar el estado del receptor o el origen del mensaje.
PeekBySequenceNumberAsync(Int64)	Lee de forma asincrónica el siguiente mensaje sin cambiar el estado del receptor o el origen del mensaje.
PeekBySequenceNumberAsync(Int64, Int32)	Busca un lote de mensajes.
ReceiveAsync()	Reciba un mensaje de la entidad definida mediante PathReceiveMode el modo .
ReceiveAsync(Int32)	Recibe un máximo de maxMessageCount mensajes de la entidad definida mediante PathReceiveMode el modo .
ReceiveAsync(Int32, TimeSpan)	Recibe un máximo de maxMessageCount mensajes de la entidad definida mediante PathReceiveMode el modo .
ReceiveAsync(TimeSpan)	Reciba un mensaje de la entidad definida mediante PathReceiveMode el modo .
ReceiveDeferredMessageAsync(IEnumerable<Int64>)	Recibe un IList<T> de mensajes diferidos identificados por sequenceNumbers.
ReceiveDeferredMessageAsync(Int64)	Recibe un mensaje diferido específico identificado por sequenceNumber.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Recibir mensajes continuamente de la entidad. Registra un controlador de mensajes y comienza un nuevo subproceso para recibir mensajes. El receptor espera este controlador(Func<T1,T2,TResult>) cada vez que el receptor recibe un nuevo mensaje.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions)	Recibir mensajes continuamente de la entidad. Registra un controlador de mensajes y comienza un nuevo subproceso para recibir mensajes. El receptor espera este controlador(Func<T1,T2,TResult>) cada vez que el receptor recibe un nuevo mensaje.
RegisterPlugin(ServiceBusPlugin)	Registra un ServiceBusPlugin objeto que se va a usar con este receptor.
RenewLockAsync(Message)	Renueva el bloqueo en el mensaje especificado por el token de bloqueo. El bloqueo se renovará en función de la configuración especificada en la cola.
RenewLockAsync(String)	Renueva el bloqueo en el mensaje. El bloqueo se renovará en función de la configuración especificada en la cola. Nueva fecha y hora de expiración del token de bloqueo en formato UTC.
ThrowIfClosed()	Inicie una operationCanceledException si el objeto es Closing. (Heredado de ClientEntity)
UnregisterMessageHandlerAsync(TimeSpan)	Anule el registro del controlador de mensajes del receptor si hay un controlador de mensajes activo registrado. Esta operación espera a que finalicen las operaciones de recepción y control de mensajes en curso para finalizar y anular el registro de las futuras recepciones en el controlador de mensajes que se registró anteriormente.
UnregisterPlugin(String)	Anula el registro de un ServiceBusPluginobjeto .