Partilhar via


IQueueClient Interface

Definição

QueueClient pode ser usado para todas as interações básicas com uma Fila do Barramento de Serviço.

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
Implementações

Exemplos

Criar um novo QueueClient

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

Envie uma mensagem para a fila:

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

Registre um manipulador de mensagens que será invocado sempre que uma mensagem for recebida.

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;
       });

Comentários

Use IMessageSender ou IMessageReceiver para um conjunto avançado de funcionalidades.

Propriedades

ClientId

Obtém a ID para identificar esse cliente. Isso pode ser usado para correlacionar logs e exceções.

(Herdado de IClientEntity)
IsClosedOrClosing

Retornará true se o cliente estiver fechado ou fechado.

(Herdado de IClientEntity)
OperationTimeout

Duração após a qual as operações individuais terão tempo limite.

(Herdado de IClientEntity)
OwnsConnection

Retornará true se a conexão for de propriedade e false se a conexão for compartilhada.

(Herdado de IClientEntity)
Path

Obtém o caminho da entidade.

(Herdado de IClientEntity)
PrefetchCount

A pré-busca acelera o fluxo de mensagens com o objetivo de ter uma mensagem prontamente disponível para recuperação local quando e antes que o aplicativo solicite uma usando Receive. Definir um valor diferente de zero pré-busca o número de mensagens PrefetchCount. Definir o valor como zero desativa a pré-busca. Assume o padrão de 0.

(Herdado de IReceiverClient)
QueueName

Obtém o nome da fila.

ReceiveMode

Obtém o ReceiveMode do receptor atual.

(Herdado de IReceiverClient)
RegisteredPlugins

Obtém uma lista de plug-ins registrados no momento para este cliente.

(Herdado de IClientEntity)
ServiceBusConnection

Objeto de conexão com o namespace do barramento de serviço.

(Herdado de IClientEntity)

Métodos

AbandonAsync(String, IDictionary<String,Object>)

Abandona um Message usando um token de bloqueio. Isso disponibilizará a mensagem novamente para processamento.

(Herdado de IReceiverClient)
CancelScheduledMessageAsync(Int64)

Cancela uma mensagem que foi agendada.

(Herdado de ISenderClient)
CloseAsync()

Fecha o Cliente. Fecha as conexões abertas por ela.

(Herdado de IClientEntity)
CompleteAsync(String)

Conclui um Message usando seu token de bloqueio. Isso excluirá a mensagem da fila.

(Herdado de IReceiverClient)
DeadLetterAsync(String, IDictionary<String,Object>)

Move uma mensagem para a sub-fila de mensagens mortas.

(Herdado de IReceiverClient)
DeadLetterAsync(String, String, String)

Move uma mensagem para a sub-fila de mensagens mortas.

(Herdado de IReceiverClient)
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)

Receber mensagens continuamente da entidade. Registra um manipulador de mensagens e inicia um novo thread para receber mensagens. Esse manipulador(Func<T1,T2,TResult>) é aguardado sempre que uma nova mensagem é recebida pelo receptor.

(Herdado de IReceiverClient)
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions)

Receber mensagens continuamente da entidade. Registra um manipulador de mensagens e inicia um novo thread para receber mensagens. Esse manipulador(Func<T1,T2,TResult>) é aguardado sempre que uma nova mensagem é recebida pelo receptor.

(Herdado de IReceiverClient)
RegisterPlugin(ServiceBusPlugin)

Registra um ServiceBusPlugin a ser usado com esse cliente.

(Herdado de IClientEntity)
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)

Receber mensagens de sessão continuamente da fila. Registra um manipulador de mensagens e inicia um novo thread para receber mensagens de sessão. Esse manipulador(Func<T1,T2,T3,TResult>) é aguardado sempre que uma nova mensagem é recebida pelo cliente da fila.

RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, SessionHandlerOptions)

Receber mensagens de sessão continuamente da fila. Registra um manipulador de mensagens e inicia um novo thread para receber mensagens de sessão. Esse manipulador(Func<T1,T2,T3,TResult>) é aguardado sempre que uma nova mensagem é recebida pelo cliente da fila.

ScheduleMessageAsync(Message, DateTimeOffset)

Agenda uma mensagem para aparecer no Barramento de Serviço.

(Herdado de ISenderClient)
SendAsync(IList<Message>)

Envia uma lista de mensagens para o Barramento de Serviço. Quando chamado em entidades particionadas, as mensagens destinadas a partições diferentes não podem ser agrupadas em lote.

(Herdado de ISenderClient)
SendAsync(Message)

Envia uma mensagem para o Barramento de Serviço.

(Herdado de ISenderClient)
UnregisterMessageHandlerAsync(TimeSpan)

Cancele o registro do manipulador de mensagens do receptor se houver um manipulador de mensagens ativo registrado. Esta operação aguarda a conclusão das operações de recebimento e tratamento de mensagens de bordo para concluir e cancela o registro de recebimentos futuros no manipulador de mensagens registrado anteriormente.

(Herdado de IReceiverClient)
UnregisterPlugin(String)

Cancela o registro de um ServiceBusPlugin.

(Herdado de IClientEntity)
UnregisterSessionHandlerAsync(TimeSpan)

Cancele o registro do manipulador de sessão do receptor se houver um manipulador de sessão ativo registrado. Esta operação aguarda a conclusão das operações de tratamento de sessão e recebimento de simulação para concluir e cancela o registro de recebimentos futuros no manipulador de sessão registrado anteriormente.

Aplica-se a

Confira também