SubscriptionClient Classe

Definição

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

public abstract class SubscriptionClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient
type SubscriptionClient = class
    inherit MessagingEntityClient
Public MustInherit Class SubscriptionClient
Inherits MessagingEntityClient
Herança

Exemplos

// Create subscription client
SubscriptionClient mySubscriptionClient = 
factory.CreateSubscriptionClient(mySubscription);

// Receive messages
for (int count = 0; count < MsgCount; count++)
{
    var message = mySubscriptionClient.Receive();
    message.Complete();
}

Propriedades

IsClosed

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
MessagingFactory

Obtém a fábrica de mensagens usada para criar esse cliente de assinatura.

Mode

Obtém o modo de recebimento da mensagem ao processar a mensagem recebida.

Name

Obtém o nome da assinatura.

Path

Obtém o caminho da fila, do tópico ou da assinatura em relação ao MessagingFactory endereço base.

(Herdado de MessagingEntityClient)
PrefetchCount

Obtém ou define o número de mensagens que o destinatário da mensagem pode solicitar simultaneamente.

RetryPolicy

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
ThisLock

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
TopicPath

Obtém o nome de caminho completo do tópico.

Métodos

Abandon(Guid)

Descarta a mensagem e abre mão da propriedade do bloqueio de mensagem.

Abandon(Guid, IDictionary<String,Object>)

Descarta a mensagem e abre mão da propriedade do bloqueio de mensagem.

AbandonAsync(Guid)

Descarta a mensagem de forma assíncrona e renuncia à propriedade do bloqueio de mensagem.

AbandonAsync(Guid, IDictionary<String,Object>)

Descarta a mensagem de forma assíncrona e renuncia à propriedade do bloqueio de mensagem.

Abort()

Executa a funcionalidade de anulação na entidade de mensagens.

(Herdado de ClientEntity)
AcceptMessageSession()

Aceita uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação.

AcceptMessageSession(Boolean)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSession(Boolean, TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSession(String)

Aceita uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o identificador de sessão especificado.

AcceptMessageSession(String, Boolean)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSession(String, Boolean, TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSession(String, Guid)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSession(String, Guid, TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSession(String, TimeSpan)

Aceita uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o identificador de sessão especificado e o tempo de espera.

AcceptMessageSession(TimeSpan)

Aceita uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o tempo de espera do servidor especificado.

AcceptMessageSessionAsync()

Aceita de forma assíncrona uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o tempo de espera do servidor especificado.

AcceptMessageSessionAsync(Boolean)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSessionAsync(Boolean, TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSessionAsync(String)

Aceita de forma assíncrona uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o tempo de espera do servidor especificado.

AcceptMessageSessionAsync(String, Boolean)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSessionAsync(String, Boolean, TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSessionAsync(String, Guid)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSessionAsync(String, Guid, TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

AcceptMessageSessionAsync(String, TimeSpan)

Aceita de forma assíncrona uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o tempo de espera do servidor especificado.

AcceptMessageSessionAsync(TimeSpan)

Aceita de forma assíncrona uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação usando o tempo de espera do servidor especificado.

AddRule(RuleDescription)

Adiciona uma nova regra ao SubscriptionDescription usando a descrição da regra especificada.

AddRule(String, Filter)

Adiciona uma regra à assinatura atual com o nome e a expressão de filtro especificados.

AddRuleAsync(RuleDescription)

Adiciona de forma assíncrona uma nova regra ao SubscriptionDescription usando a descrição da regra especificada.

AddRuleAsync(String, Filter)

Adiciona de forma assíncrona uma regra à assinatura atual com o nome e a expressão de filtro especificados.

Close()

Envia uma mensagem de limpeza para o Barramento de Serviço para sinalizar a conclusão do uso de uma entidade.

(Herdado de ClientEntity)
CloseAsync()

Envia uma mensagem de limpeza de forma assíncrona para o Barramento de Serviço para sinalizar a conclusão do uso de uma entidade.

(Herdado de ClientEntity)
Complete(Guid)

Conclui o processamento de uma mensagem.

CompleteAsync(Guid)

Conclui de forma assíncrona o processamento de uma mensagem.

CompleteBatch(IEnumerable<Guid>)

Conclui o processamento de um lote.

CompleteBatchAsync(IEnumerable<Guid>)

Conclui de forma assíncrona o processamento de um lote.

Create(String, String)

Cria uma nova cópia de com o nome e o caminho do SubscriptionClient tópico especificados.

Create(String, String, ReceiveMode)

Cria uma nova cópia de SubscriptionClient com nome, caminho de tópico e modo especificados.

CreateFromConnectionString(String, String, String)

Cria uma nova cópia de de uma cadeia de SubscriptionClient conexão com o caminho e o nome do tópico especificados.

CreateFromConnectionString(String, String, String, ReceiveMode)

Cria uma nova cópia de de uma cadeia de SubscriptionClient conexão com o caminho, o nome e o modo do tópico especificados.

CreateWithAzureActiveDirectory(Uri, String, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType)

Cria uma nova instância do usando o SubscriptionClient retorno de chamada de autenticação .

CreateWithManagedIdentity(Uri, String, String, ReceiveMode, Nullable<TimeSpan>, TransportType)

Cria uma nova instância do usando a SubscriptionClient autenticação de Identidade Gerenciada do Azure.

DeadLetter(Guid)

Move a mensagem não entregue para a fila de mensagens mortas.

DeadLetter(Guid, IDictionary<String,Object>)

Move a mensagem não entregue para a fila de mensagens mortas.

DeadLetter(Guid, String, String)

Move a mensagem não entregue para a fila de mensagens mortas.

DeadLetterAsync(Guid)

Move de forma assíncrona a mensagem não entregue para a fila de mensagens mortas.

DeadLetterAsync(Guid, IDictionary<String,Object>)

Move de forma assíncrona a mensagem não entregue para a fila de mensagens mortas.

DeadLetterAsync(Guid, String, String)

Move de forma assíncrona a mensagem não entregue para a fila de mensagens mortas.

Defer(Guid)

Suspende o processamento de uma mensagem.

Defer(Guid, IDictionary<String,Object>)

Suspende o processamento de uma mensagem.

DeferAsync(Guid)

Suspende de forma assíncrona o processamento de uma mensagem.

DeferAsync(Guid, IDictionary<String,Object>)

Suspende de forma assíncrona o processamento de uma mensagem.

Fault()

Apenas para uso interno. Não herde dessa classe.

(Herdado de ClientEntity)
FormatDeadLetterPath(String, String)

Cria um caminho deadletter de nome de formato usando o caminho do tópico e o nome da assinatura especificados.

FormatSubscriptionPath(String, String)

Cria um caminho de assinatura de nome de formato usando o caminho do tópico e o nome da assinatura especificados.

GetMessageSessions()

Obtém uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação.

GetMessageSessions(DateTime)

Recupera todas as sessões de mensagem cujo estado de sessão foi atualizado desde lastUpdatedTime.

GetMessageSessionsAsync()

Obtém de forma assíncrona uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação.

GetMessageSessionsAsync(DateTime)

Obtém de forma assíncrona uma sessão de mensagem que permite o agrupamento de mensagens relacionadas para processamento em uma única transação.

OnAbort()

Executa a ação de anulação.

OnBeginAcceptMessageSession(String, ReceiveMode, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object)

Executa ao chamar a operação BeginAcceptMessageSession.

OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)

Executa ao chamar a operação BeginAddRule.

OnBeginClose(TimeSpan, AsyncCallback, Object)

Executa a ação iniciar fechar.

OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)

Executa a ação iniciar a criação do receptor.

OnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)

Executa a ação iniciar a criação do receptor.

OnBeginGetMessageSessions(DateTime, AsyncCallback, Object)

Executa ao chamar a operação BeginGetMessageSessions.

OnBeginGetRules(Int32, Int32, TimeSpan, AsyncCallback, Object)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

OnBeginOpen(TimeSpan, AsyncCallback, Object)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)

Começa a remover um RuleDescription de um SubscriptionDescription por meio do protocolo de cliente em tempo de execução.

OnBeginRemoveRulesByTag(String, TimeSpan, AsyncCallback, Object)

Começa a remover um RuleDescription de um SubscriptionDescription por meio do protocolo de cliente em tempo de execução usando uma marca.

OnClose(TimeSpan)

Executa a ação fechar.

OnClosed()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
OnEndAcceptMessageSession(IAsyncResult)

Executa ao chamar a operação EndAcceptMessageSession.

OnEndAddRule(IAsyncResult)

Encerra a chamada assíncrona para OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object).

OnEndClose(IAsyncResult)

Executa a ação de fechamento final.

OnEndCreateReceiver(IAsyncResult)

Executa a ação do receptor de criação final.

OnEndGetMessageSessions(IAsyncResult)

Executa a ação end get message.

OnEndGetRules(IAsyncResult)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

OnEndOpen(IAsyncResult)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
OnEndRemoveRule(IAsyncResult)

Encerra a chamada assíncrona para OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object).

OnEndRemoveRules(IAsyncResult)

Encerra a chamada assíncrona para OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object).

OnFaulted()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
OnMessage(Action<BrokeredMessage>)

Processa uma mensagem em uma bomba de mensagem controlada por eventos.

OnMessage(Action<BrokeredMessage>, OnMessageOptions)

Processa uma mensagem em uma bomba de mensagem controlada por eventos, com o conjunto de OnMessageOptions opções fornecido.

OnMessageAsync(Func<BrokeredMessage,Task>)

Processa de forma assíncrona uma mensagem.

OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)

Processa de forma assíncrona uma mensagem.

OnOpen(TimeSpan)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
OnOpened()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
Peek()

Retorna sem remover a primeira mensagem na fila.

Peek(Int64)

Retorna sem remover a primeira mensagem na fila.

PeekAsync()

Retorna de forma assíncrona sem remover a primeira mensagem na fila.

PeekAsync(Int64)

Retorna de forma assíncrona sem remover a primeira mensagem na fila.

PeekBatch(Int32)

Retorna sem remover as primeiras mensagens em um lote.

PeekBatch(Int64, Int32)

Retorna sem remover as primeiras mensagens em um lote.

PeekBatchAsync(Int32)

Retorna de forma assíncrona sem remover as primeiras mensagens em um lote.

PeekBatchAsync(Int64, Int32)

Retorna de forma assíncrona sem remover as primeiras mensagens em um lote.

Receive()

Recebe uma mensagem usando o Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

Receive(Int64)

Recebe uma mensagem adiada usando o Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. Esse método funciona apenas para mensagens adiadas, não regulares.

Receive(TimeSpan)

Recebe uma mensagem usando o Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

ReceiveAsync()

Recebe de forma assíncrona uma mensagem usando o Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

ReceiveAsync(Int64)

Recebe de forma assíncrona uma mensagem usando o Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. Esse método funciona apenas para mensagens adiadas, não regulares.

ReceiveAsync(TimeSpan)

Recebe de forma assíncrona uma mensagem usando o Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

ReceiveBatch(IEnumerable<Int64>)

Recebe um lote após a operação assíncrona.

ReceiveBatch(Int32)

Recebe um lote após a operação assíncrona.

ReceiveBatch(Int32, TimeSpan)

Recebe um lote após a operação assíncrona.

ReceiveBatchAsync(IEnumerable<Int64>)

Recebe de forma assíncrona um conjunto de mensagens (para processamento em lote).

ReceiveBatchAsync(Int32)

Recebe de forma assíncrona um conjunto de mensagens (para processamento em lote).

ReceiveBatchAsync(Int32, TimeSpan)

Recebe de forma assíncrona um conjunto de mensagens (para processamento em lote).

RegisterSessionHandler(Type)

Registra o manipulador para a sessão do cliente.

RegisterSessionHandler(Type, SessionHandlerOptions)

Registra o manipulador para a sessão do cliente.

RegisterSessionHandlerAsync(Type)

Registra de forma assíncrona o manipulador para a sessão do cliente.

RegisterSessionHandlerAsync(Type, SessionHandlerOptions)

Registra de forma assíncrona o manipulador para a sessão do cliente.

RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Registra a fábrica de manipuladores para a sessão do cliente.

RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)

Registra a fábrica de manipuladores para a sessão do cliente.

RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Registra de forma assíncrona a fábrica de manipuladores para a sessão do cliente.

RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)

Registra de forma assíncrona a fábrica de manipuladores para a sessão do cliente.

RemoveRule(String)

Remove a regra descrita por ruleName.

RemoveRuleAsync(String)

Remove de forma assíncrona a regra descrita por ruleName.

RenewMessageLock(Guid)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

RenewMessageLockAsync(Guid)

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

ThrowIfClosed()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
ThrowIfDisposed()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
ThrowIfDisposedOrImmutable()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
ThrowIfDisposedOrNotOpen()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)
ThrowIfFaulted()

Representa a classe de âncora usada em operações em tempo de execução relacionadas a uma assinatura de tópico.

(Herdado de ClientEntity)

Aplica-se a