IMessageReceiver Interfaz

Referencia

Definición

Espacio de nombres:: Microsoft.Azure.ServiceBus.Core

Ensamblado:: Microsoft.Azure.ServiceBus.dll

Paquete:: Microsoft.Azure.ServiceBus v5.2.0

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

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

public interface IMessageReceiver : Microsoft.Azure.ServiceBus.Core.IReceiverClient

type IMessageReceiver = interface
    interface IReceiverClient
    interface IClientEntity

Public Interface IMessageReceiver
Implements IReceiverClient

Derivado: Microsoft.Azure.ServiceBus.Core.MessageReceiver

Microsoft.Azure.ServiceBus.IMessageSession

Implementaciones: 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 QueueClient o SubscriptionClient. Por ejemplo, ReceiveAsync(), que permite recibir mensajes a petición, pero también requiere que renueve manualmente los bloqueos mediante RenewLockAsync(Message).

Propiedades

ClientId	Obtiene el identificador para identificar este cliente. Esto se puede usar para correlacionar registros y excepciones. (Heredado de IClientEntity)
IsClosedOrClosing	Devuelve true si el cliente está cerrado o cerrado. (Heredado de IClientEntity)
LastPeekedSequenceNumber	Obtiene el número de secuencia del último mensaje inspeccionado.
OperationTimeout	Duración después de la cual se agotado el tiempo de espera de las operaciones individuales. (Heredado de IClientEntity)
OwnsConnection	Devuelve true si la conexión es propiedad y false si se comparte la conexión. (Heredado de IClientEntity)
Path	Obtiene la ruta de acceso de la entidad. (Heredado de IClientEntity)
PrefetchCount	La captura previa acelera el flujo de mensajes apuntando a tener un mensaje disponible para la recuperación local cuando y antes de que la aplicación solicite una mediante Receive. Si se establece un valor distinto de cero, se captura previamente el número de mensajes PrefetchCount. Al establecer el valor en cero, se desactiva la captura previa. El valor predeterminado es 0. (Heredado de IReceiverClient)
ReceiveMode	Obtiene el ReceiveMode objeto del receptor actual. (Heredado de IReceiverClient)
RegisteredPlugins	Obtiene una lista de complementos registrados actualmente para este cliente. (Heredado de IClientEntity)
ServiceBusConnection	Objeto de conexión al espacio de nombres de Service Bus. (Heredado de IClientEntity)

Métodos

AbandonAsync(String, IDictionary<String,Object>)	Abandona un Message mediante un token de bloqueo. Esto hará que el mensaje esté disponible de nuevo para su procesamiento. (Heredado de IReceiverClient)
CloseAsync()	Cierra el cliente. Cierra las conexiones abiertas por ella. (Heredado de IClientEntity)
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 objeto mediante su token de bloqueo. Esto eliminará el mensaje de la cola. (Heredado de IReceiverClient)
DeadLetterAsync(String, IDictionary<String,Object>)	Mueve un mensaje a la sub cola de mensajes fallidos. (Heredado de IReceiverClient)
DeadLetterAsync(String, String, String)	Mueve un mensaje a la sub cola de mensajes fallidos. (Heredado de IReceiverClient)
DeferAsync(String, IDictionary<String,Object>)	Indica que el receptor quiere aplazar el procesamiento del mensaje.
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 Path ReceiveMode el modo .
ReceiveAsync(Int32)	Recibe un máximo de `maxMessageCount` mensajes de la entidad definida mediante Path ReceiveMode el modo .
ReceiveAsync(Int32, TimeSpan)	Recibe un máximo de `maxMessageCount` mensajes de la entidad definida mediante Path ReceiveMode el modo .
ReceiveAsync(TimeSpan)	Reciba un mensaje de la entidad definida mediante Path ReceiveMode el modo .
ReceiveDeferredMessageAsync(IEnumerable<Int64>)	Recibe un IList<T> objeto 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 recibe este controlador(Func<T1,T2,TResult>) cada vez que el receptor recibe un nuevo mensaje. (Heredado de IReceiverClient)
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 recibe este controlador(Func<T1,T2,TResult>) cada vez que el receptor recibe un nuevo mensaje. (Heredado de IReceiverClient)
RegisterPlugin(ServiceBusPlugin)	Registra un ServiceBusPlugin objeto que se va a usar con este cliente. (Heredado de IClientEntity)
RenewLockAsync(Message)	Renueva el bloqueo en el mensaje. 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.
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 para finalizar y anular el registro de las futuras recepciones en el controlador de mensajes que se registró anteriormente. (Heredado de IReceiverClient)
UnregisterPlugin(String)	Anula el registro de un ServiceBusPluginobjeto . (Heredado de IClientEntity)

Se aplica a

Compartir a través de