IQueueClient Interfaz

Definición

Espacio de nombres:

Microsoft.Azure.ServiceBus

Ensamblado:

Microsoft.Azure.ServiceBus.dll

Paquete:

Microsoft.Azure.ServiceBus v5.2.0

QueueClient se puede usar para todas las interacciones básicas con una cola de Service Bus.

public interface IQueueClient : Microsoft.Azure.ServiceBus.Core.IReceiverClient, Microsoft.Azure.ServiceBus.Core.ISenderClient

type IQueueClient = interface
    interface IReceiverClient
    interface IClientEntity
    interface ISenderClient

Public Interface IQueueClient
Implements IReceiverClient, ISenderClient

Derivado

Microsoft.Azure.ServiceBus.QueueClient

Implementaciones

IReceiverClient ISenderClient IClientEntity

Ejemplos

Creación de una nueva queueClient

IQueueClient queueClient = new QueueClient(
    namespaceConnectionString,
    queueName,
    ReceiveMode.PeekLock,
    RetryExponential);

Envíe un mensaje a la cola:

byte[] data = GetData();
await queueClient.SendAsync(data);

Registre un controlador de mensajes que se invocará cada vez que se reciba un mensaje.

queueClient.RegisterMessageHandler(
       async (message, token) =>
       {
           // Process the message
           Console.WriteLine($"Received message: SequenceNumber:{message.SystemProperties.SequenceNumber} Body:{Encoding.UTF8.GetString(message.Body)}");

           // Complete the message so that it is not received again.
           // This can be done only if the queueClient is opened in ReceiveMode.PeekLock mode.
           await queueClient.CompleteAsync(message.SystemProperties.LockToken);
       },
       async (exceptionEvent) =>
       {
           // Process the exception
           Console.WriteLine("Exception = " + exceptionEvent.Exception);
           return Task.CompletedTask;
       });

Comentarios

Use IMessageSender o IMessageReceiver para un conjunto avanzado de funcionalidades.

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)
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)
QueueName	Obtiene el nombre de la cola.
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)
CancelScheduledMessageAsync(Int64)	Cancela un mensaje programado. (Heredado de ISenderClient)
CloseAsync()	Cierra el cliente. Cierra las conexiones abiertas por ella. (Heredado de IClientEntity)
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)
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)
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Recibir mensajes de sesión continuamente de la cola. Registra un controlador de mensajes y comienza un nuevo subproceso para recibir mensajes de sesión. El cliente de cola recibe este controlador(Func<T1,T2,T3,TResult>) cada vez que el cliente de cola recibe un nuevo mensaje.
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, SessionHandlerOptions)	Recibir mensajes de sesión continuamente de la cola. Registra un controlador de mensajes y comienza un nuevo subproceso para recibir mensajes de sesión. El cliente de cola recibe este controlador(Func<T1,T2,T3,TResult>) cada vez que el cliente de cola recibe un nuevo mensaje.
ScheduleMessageAsync(Message, DateTimeOffset)	Programa un mensaje para que aparezca en Service Bus. (Heredado de ISenderClient)
SendAsync(IList<Message>)	Envía una lista de mensajes a Service Bus. Cuando se llama a en entidades con particiones, los mensajes destinados a distintas particiones no se pueden procesar por lotes juntos. (Heredado de ISenderClient)
SendAsync(Message)	Envía un mensaje a Service Bus. (Heredado de ISenderClient)
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)
UnregisterSessionHandlerAsync(TimeSpan)	Anule el registro del controlador de sesión del receptor si hay un controlador de sesión activo registrado. Esta operación espera a que finalicen las operaciones de recepción y control de sesiones para finalizar y anular el registro de las futuras recepciones en el controlador de sesión que se registró anteriormente.

Consulte también

• QueueClient