SubscriptionClient Clase

Definición

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

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

Ejemplos

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

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

Propiedades

IsClosed

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
MessagingFactory

Obtiene el generador de mensajería usado para crear este cliente de suscripción.

Mode

Obtiene el modo de recepción del mensaje al procesar el mensaje recibido.

Name

Obtiene el nombre de la suscripción.

Path

Obtiene la ruta de acceso de la cola, el tema o la suscripción en relación con la MessagingFactory dirección base.

(Heredado de MessagingEntityClient)
PrefetchCount

Obtiene o establece el número de mensajes que el destinatario del mensaje puede solicitar simultáneamente.

RetryPolicy

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
ThisLock

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
TopicPath

Obtiene el nombre de ruta de acceso completo del tema.

Métodos

Abandon(Guid)

Descarta el mensaje y renuncia a la propiedad del bloqueo del mensaje.

Abandon(Guid, IDictionary<String,Object>)

Descarta el mensaje y renuncia a la propiedad del bloqueo del mensaje.

AbandonAsync(Guid)

Descarta de forma asincrónica el mensaje y renuncia a la propiedad del bloqueo del mensaje.

AbandonAsync(Guid, IDictionary<String,Object>)

Descarta de forma asincrónica el mensaje y renuncia a la propiedad del bloqueo del mensaje.

Abort()

Realiza la funcionalidad de anulación en la entidad de mensajería.

(Heredado de ClientEntity)
AcceptMessageSession()

Acepta una sesión de mensaje que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción.

AcceptMessageSession(Boolean)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSession(Boolean, TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSession(String)

Acepta una sesión de mensaje que permite agrupar mensajes relacionados para su procesamiento en una sola transacción mediante el identificador de sesión especificado.

AcceptMessageSession(String, Boolean)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSession(String, Boolean, TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSession(String, Guid)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSession(String, Guid, TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSession(String, TimeSpan)

Acepta una sesión de mensajes que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción mediante el identificador de sesión y el tiempo de espera especificados.

AcceptMessageSession(TimeSpan)

Acepta una sesión de mensaje que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción mediante el tiempo de espera del servidor especificado.

AcceptMessageSessionAsync()

Acepta de forma asincrónica una sesión de mensajes que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción mediante el tiempo de espera del servidor especificado.

AcceptMessageSessionAsync(Boolean)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSessionAsync(Boolean, TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSessionAsync(String)

Acepta de forma asincrónica una sesión de mensajes que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción mediante el tiempo de espera del servidor especificado.

AcceptMessageSessionAsync(String, Boolean)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSessionAsync(String, Boolean, TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSessionAsync(String, Guid)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSessionAsync(String, Guid, TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

AcceptMessageSessionAsync(String, TimeSpan)

Acepta de forma asincrónica una sesión de mensajes que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción mediante el tiempo de espera del servidor especificado.

AcceptMessageSessionAsync(TimeSpan)

Acepta de forma asincrónica una sesión de mensajes que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción mediante el tiempo de espera del servidor especificado.

AddRule(RuleDescription)

Agrega una nueva regla a SubscriptionDescription mediante la descripción de la regla especificada.

AddRule(String, Filter)

Agrega una regla a la suscripción actual con el nombre y la expresión de filtro especificados.

AddRuleAsync(RuleDescription)

Agrega de forma asincrónica una nueva regla a SubscriptionDescription mediante la descripción de la regla especificada.

AddRuleAsync(String, Filter)

Agrega de forma asincrónica una regla a la suscripción actual con el nombre y la expresión de filtro especificados.

Close()

Envía un mensaje de limpieza a Service Bus para indicar la finalización del uso de una entidad.

(Heredado de ClientEntity)
CloseAsync()

Envía un mensaje de limpieza de forma asincrónica a Service Bus para indicar la finalización del uso de una entidad.

(Heredado de ClientEntity)
Complete(Guid)

Completa el procesamiento de un mensaje.

CompleteAsync(Guid)

Completa de forma asincrónica el procesamiento de un mensaje.

CompleteBatch(IEnumerable<Guid>)

Completa el procesamiento de un lote.

CompleteBatchAsync(IEnumerable<Guid>)

Completa de forma asincrónica el procesamiento de un lote.

Create(String, String)

Crea una nueva copia de con el nombre y la ruta de SubscriptionClient acceso del tema especificados.

Create(String, String, ReceiveMode)

Crea una nueva copia de con el nombre, la ruta de SubscriptionClient acceso al tema y el modo especificados.

CreateFromConnectionString(String, String, String)

Crea una nueva copia de a partir de una cadena de conexión con la ruta de SubscriptionClient acceso y el nombre del tema especificados.

CreateFromConnectionString(String, String, String, ReceiveMode)

Crea una nueva copia de a partir de una cadena de conexión con la ruta de SubscriptionClient acceso, el nombre y el modo de tema especificados.

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

Crea una nueva instancia de mediante la SubscriptionClient devolución de llamada de autenticación .

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

Crea una nueva instancia de mediante la SubscriptionClient autenticación de identidad administrada de Azure.

DeadLetter(Guid)

Mueve el mensaje no entregado a la cola de mensajes fallidos.

DeadLetter(Guid, IDictionary<String,Object>)

Mueve el mensaje no entregado a la cola de mensajes fallidos.

DeadLetter(Guid, String, String)

Mueve el mensaje no entregado a la cola de mensajes fallidos.

DeadLetterAsync(Guid)

Mueve de forma asincrónica el mensaje no entregado a la cola de mensajes fallidos.

DeadLetterAsync(Guid, IDictionary<String,Object>)

Mueve de forma asincrónica el mensaje no entregado a la cola de mensajes fallidos.

DeadLetterAsync(Guid, String, String)

Mueve de forma asincrónica el mensaje no entregado a la cola de mensajes fallidos.

Defer(Guid)

Suspende el procesamiento de un mensaje.

Defer(Guid, IDictionary<String,Object>)

Suspende el procesamiento de un mensaje.

DeferAsync(Guid)

Suspende de forma asincrónica el procesamiento de un mensaje.

DeferAsync(Guid, IDictionary<String,Object>)

Suspende de forma asincrónica el procesamiento de un mensaje.

Fault()

Solo para uso interno. No herede de esta clase.

(Heredado de ClientEntity)
FormatDeadLetterPath(String, String)

Crea una ruta de acceso de mensajes fallidos de nombre de formato mediante la ruta de acceso del tema y el nombre de la suscripción especificados.

FormatSubscriptionPath(String, String)

Crea una ruta de acceso de suscripción de nombre de formato mediante la ruta de acceso del tema y el nombre de la suscripción especificados.

GetMessageSessions()

Obtiene una sesión de mensajes que permite la agrupación de mensajes relacionados para su procesamiento en una sola transacción.

GetMessageSessions(DateTime)

Recupera todas las sesiones de mensaje cuyo estado de sesión se actualizó desde lastUpdatedTime.

GetMessageSessionsAsync()

Obtiene de forma asincrónica una sesión de mensajes que permite agrupar mensajes relacionados para su procesamiento en una sola transacción.

GetMessageSessionsAsync(DateTime)

Obtiene de forma asincrónica una sesión de mensajes que permite agrupar mensajes relacionados para su procesamiento en una sola transacción.

OnAbort()

Ejecuta la acción de anulación.

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

Se ejecuta al llamar a la operación BeginAcceptMessageSession.

OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)

Se ejecuta al llamar a la operación BeginAddRule.

OnBeginClose(TimeSpan, AsyncCallback, Object)

Ejecuta la acción begin close.

OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)

Ejecuta la acción begin create receiver.

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

Ejecuta la acción begin create receiver.

OnBeginGetMessageSessions(DateTime, AsyncCallback, Object)

Se ejecuta al llamar a la operación BeginGetMessageSessions.

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

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

OnBeginOpen(TimeSpan, AsyncCallback, Object)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

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

Comienza a quitar un elemento RuleDescription de a SubscriptionDescription través del protocolo de cliente en tiempo de ejecución.

OnBeginRemoveRulesByTag(String, TimeSpan, AsyncCallback, Object)

Comienza a quitar un elemento RuleDescription de a SubscriptionDescription través del protocolo de cliente en tiempo de ejecución mediante una etiqueta .

OnClose(TimeSpan)

Ejecuta la acción de cierre.

OnClosed()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
OnEndAcceptMessageSession(IAsyncResult)

Se ejecuta al llamar a la operación EndAcceptMessageSession.

OnEndAddRule(IAsyncResult)

Finaliza la llamada asincrónica a OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object).

OnEndClose(IAsyncResult)

Ejecuta la acción de cierre final.

OnEndCreateReceiver(IAsyncResult)

Ejecuta la acción de creación del receptor final.

OnEndGetMessageSessions(IAsyncResult)

Ejecuta la acción de obtención del mensaje final.

OnEndGetRules(IAsyncResult)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

OnEndOpen(IAsyncResult)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
OnEndRemoveRule(IAsyncResult)

Finaliza la llamada asincrónica a OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object).

OnEndRemoveRules(IAsyncResult)

Finaliza la llamada asincrónica a OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object).

OnFaulted()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

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

Procesa un mensaje en una bomba de mensajes controlada por eventos.

OnMessage(Action<BrokeredMessage>, OnMessageOptions)

Procesa un mensaje en una bomba de mensajes controlada por eventos, con el conjunto de OnMessageOptions opciones especificado.

OnMessageAsync(Func<BrokeredMessage,Task>)

Procesa de forma asincrónica un mensaje.

OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)

Procesa de forma asincrónica un mensaje.

OnOpen(TimeSpan)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
OnOpened()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
Peek()

Devuelve sin quitar el primer mensaje de la cola.

Peek(Int64)

Devuelve sin quitar el primer mensaje de la cola.

PeekAsync()

Devuelve de forma asincrónica sin quitar el primer mensaje de la cola.

PeekAsync(Int64)

Devuelve de forma asincrónica sin quitar el primer mensaje de la cola.

PeekBatch(Int32)

Devuelve sin quitar los primeros mensajes de un lote.

PeekBatch(Int64, Int32)

Devuelve sin quitar los primeros mensajes de un lote.

PeekBatchAsync(Int32)

Devuelve de forma asincrónica sin quitar los primeros mensajes de un lote.

PeekBatchAsync(Int64, Int32)

Devuelve de forma asincrónica sin quitar los primeros mensajes de un lote.

Receive()

Recibe un mensaje mediante Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

Receive(Int64)

Recibe un mensaje diferido mediante .Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver Este método solo funciona para el mensaje diferido, no para uno normal.

Receive(TimeSpan)

Recibe un mensaje mediante Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver.

ReceiveAsync()

Recibe de forma asincrónica un mensaje mediante .Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver

ReceiveAsync(Int64)

Recibe de forma asincrónica un mensaje mediante .Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver Este método solo funciona para el mensaje diferido, no para uno normal.

ReceiveAsync(TimeSpan)

Recibe de forma asincrónica un mensaje mediante .Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver

ReceiveBatch(IEnumerable<Int64>)

Recibe un lote después de la operación asincrónica.

ReceiveBatch(Int32)

Recibe un lote después de la operación asincrónica.

ReceiveBatch(Int32, TimeSpan)

Recibe un lote después de la operación asincrónica.

ReceiveBatchAsync(IEnumerable<Int64>)

Recibe de forma asincrónica un conjunto de mensajes (para el procesamiento por lotes).

ReceiveBatchAsync(Int32)

Recibe de forma asincrónica un conjunto de mensajes (para el procesamiento por lotes).

ReceiveBatchAsync(Int32, TimeSpan)

Recibe de forma asincrónica un conjunto de mensajes (para el procesamiento por lotes).

RegisterSessionHandler(Type)

Registra el controlador para la sesión de cliente.

RegisterSessionHandler(Type, SessionHandlerOptions)

Registra el controlador para la sesión de cliente.

RegisterSessionHandlerAsync(Type)

Registra de forma asincrónica el controlador para la sesión de cliente.

RegisterSessionHandlerAsync(Type, SessionHandlerOptions)

Registra de forma asincrónica el controlador para la sesión de cliente.

RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Registra el generador de controladores para la sesión de cliente.

RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)

Registra el generador de controladores para la sesión de cliente.

RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Registra de forma asincrónica el generador de controladores para la sesión de cliente.

RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)

Registra de forma asincrónica el generador de controladores para la sesión de cliente.

RemoveRule(String)

Quita la regla descrita por ruleName.

RemoveRuleAsync(String)

Quita de forma asincrónica la regla descrita por ruleName.

RenewMessageLock(Guid)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

RenewMessageLockAsync(Guid)

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

ThrowIfClosed()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
ThrowIfDisposed()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
ThrowIfDisposedOrImmutable()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
ThrowIfDisposedOrNotOpen()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)
ThrowIfFaulted()

Representa la clase de delimitador usada en operaciones en tiempo de ejecución relacionadas con una suscripción de tema.

(Heredado de ClientEntity)

Se aplica a