IMessageSession Interfaz

Definición

Espacio de nombres:

Microsoft.Azure.ServiceBus

Ensamblado:

Microsoft.Azure.ServiceBus.dll

Paquete:

Microsoft.Azure.ServiceBus v5.2.0

Describe un objeto Session. IMessageSession se puede usar para realizar operaciones en sesiones.

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

type IMessageSession = interface
    interface IMessageReceiver
    interface IReceiverClient
    interface IClientEntity

Public Interface IMessageSession
Implements IMessageReceiver

Implementaciones

IMessageReceiver IReceiverClient IClientEntity

Comentarios

Las sesiones de Service Bus, también denominadas "Grupos" en el protocolo AMQP 1.0, son secuencias sin enlazar de mensajes relacionados. ServiceBus garantiza el orden de los mensajes en una sesión.

Cualquier remitente puede crear una sesión al enviar mensajes a un tema o cola estableciendo la propiedad en Message en algún identificador único definido por la SessionId aplicación. En el nivel de protocolo AMQP 1.0, este valor se asigna a la propiedad group-id.

Las sesiones entran en vigor cuando hay al menos un mensaje con el SessionId de la sesión en la suscripción Cola o Tema. Una vez que existe una sesión, no hay ningún momento o gesto definido para cuándo expira o desaparece la sesión.

Propiedades

ClientId	Obtiene el identificador para identificar este cliente. 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 que se ha inspeccionado. (Heredado de IMessageReceiver)
LockedUntilUtc	Obtiene la hora a la que se bloquea la sesión identificada por SessionId hasta que este cliente.
OperationTimeout	Duración después de la cual se expirarán 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 con el objetivo de tener un mensaje disponible para la recuperación local cuando y antes de que la aplicación solicite una mediante Receive. Establecer una captura previa de valor distinto de cero prefetchCount número de mensajes. 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)
SessionId	Obtiene el sessionId.

Métodos

AbandonAsync(String, IDictionary<String,Object>)	Abandona un Message mediante un token de bloqueo. Esto hará que el mensaje vuelva a estar disponible 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. (Heredado de IMessageReceiver)
CompleteAsync(String)	Completa un Message 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 subcola de mensajes fallidos. (Heredado de IReceiverClient)
DeadLetterAsync(String, String, String)	Mueve un mensaje a la subcola de mensajes fallidos. (Heredado de IReceiverClient)
DeferAsync(String, IDictionary<String,Object>)	Indica que el receptor quiere aplazar el procesamiento del mensaje. (Heredado de IMessageReceiver)
GetStateAsync()	Obtiene el estado de sesión.
PeekAsync()	Captura el siguiente mensaje activo sin cambiar el estado del receptor o el origen del mensaje. (Heredado de IMessageReceiver)
PeekAsync(Int32)	Captura el siguiente lote de mensajes activos sin cambiar el estado del receptor o el origen del mensaje. (Heredado de IMessageReceiver)
PeekBySequenceNumberAsync(Int64)	Lee de forma asincrónica el siguiente mensaje sin cambiar el estado del receptor o el origen del mensaje. (Heredado de IMessageReceiver)
PeekBySequenceNumberAsync(Int64, Int32)	Busca un lote de mensajes. (Heredado de IMessageReceiver)
ReceiveAsync()	Reciba un mensaje de la entidad definida mediante PathReceiveMode el modo . (Heredado de IMessageReceiver)
ReceiveAsync(Int32)	Recibe un máximo de maxMessageCount mensajes de la entidad definida mediante PathReceiveMode el modo . (Heredado de IMessageReceiver)
ReceiveAsync(Int32, TimeSpan)	Recibe un máximo de maxMessageCount mensajes de la entidad definida mediante PathReceiveMode el modo . (Heredado de IMessageReceiver)
ReceiveAsync(TimeSpan)	Reciba un mensaje de la entidad definida mediante PathReceiveMode el modo . (Heredado de IMessageReceiver)
ReceiveDeferredMessageAsync(IEnumerable<Int64>)	Recibe un IList<T> de mensajes diferidos identificados por sequenceNumbers. (Heredado de IMessageReceiver)
ReceiveDeferredMessageAsync(Int64)	Recibe un mensaje diferido específico identificado por sequenceNumber. (Heredado de IMessageReceiver)
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 espera 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 espera 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. (Heredado de IMessageReceiver)
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. (Heredado de IMessageReceiver)
RenewSessionLockAsync()	Renueva el bloqueo en la sesión especificada por .SessionId El bloqueo se renovará en función de la configuración especificada en la entidad.
SetStateAsync(Byte[])	Establecer un estado personalizado en la sesión que se puede recuperar más adelante mediante GetStateAsync()
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 en curso 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)