IQueueClient Schnittstelle

Definition

Namespace:

Microsoft.Azure.ServiceBus

Assembly:

Microsoft.Azure.ServiceBus.dll

Paket:

Microsoft.Azure.ServiceBus v5.2.0

QueueClient kann für alle grundlegenden Interaktionen mit einer Service Bus-Warteschlange verwendet werden.

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

Abgeleitet

Microsoft.Azure.ServiceBus.QueueClient

Implementiert

IReceiverClient ISenderClient IClientEntity

Beispiele

Erstellen eines neuen QueueClient

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

Senden Sie eine Nachricht an die Warteschlange:

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

Registrieren Sie einen Nachrichtenhandler, der jedes Mal aufgerufen wird, wenn eine Nachricht empfangen wird.

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

Hinweise

Verwenden Sie IMessageSender oder IMessageReceiver für erweiterte Funktionen.

Eigenschaften

ClientId	Ruft die ID ab, um diesen Client zu identifizieren. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. (Geerbt von IClientEntity)
IsClosedOrClosing	Gibt true zurück, wenn der Client geschlossen oder geschlossen ist. (Geerbt von IClientEntity)
OperationTimeout	Dauer, nach der für einzelne Vorgänge ein Timeout auftritt. (Geerbt von IClientEntity)
OwnsConnection	Gibt true zurück, wenn die Verbindung im Besitz ist, und false, wenn die Verbindung freigegeben wird. (Geerbt von IClientEntity)
Path	Ruft den Entitätspfad ab. (Geerbt von IClientEntity)
PrefetchCount	Prefetch beschleunigt den Nachrichtenfluss, indem eine Nachricht für den lokalen Abruf verfügbar ist, wenn und bevor die Anwendung mithilfe von Receive nach einer Nachricht fragt. Wenn Sie einen Wert ungleich 0 festlegen, wird die PrefetchCount-Anzahl von Nachrichten vorab angezeigt. Wenn Sie den Wert auf 0 festlegen, wird das Prefetch deaktiviert. Der Standardwert ist 0. (Geerbt von IReceiverClient)
QueueName	Ruft den Namen der Warteschlange ab.
ReceiveMode	Ruft den ReceiveMode des aktuellen Empfängers ab. (Geerbt von IReceiverClient)
RegisteredPlugins	Ruft eine Liste der aktuell registrierten Plug-Ins für diesen Client ab. (Geerbt von IClientEntity)
ServiceBusConnection	Verbindungsobjekt mit dem Service Bus-Namespace. (Geerbt von IClientEntity)

Methoden

AbandonAsync(String, IDictionary<String,Object>)	Beendet ein Message mithilfe eines Sperrtokens. Dadurch wird die Nachricht wieder für die Verarbeitung verfügbar. (Geerbt von IReceiverClient)
CancelScheduledMessageAsync(Int64)	Bricht eine geplante Nachricht ab. (Geerbt von ISenderClient)
CloseAsync()	Schließt den Client. Schließt die von ihr geöffneten Verbindungen. (Geerbt von IClientEntity)
CompleteAsync(String)	Schließt ein Message mithilfe des zugehörigen Sperrtokens ab. Dadurch wird die Nachricht aus der Warteschlange gelöscht. (Geerbt von IReceiverClient)
DeadLetterAsync(String, IDictionary<String,Object>)	Verschiebt eine Nachricht in die Unterwarteschlange des Deadletters. (Geerbt von IReceiverClient)
DeadLetterAsync(String, String, String)	Verschiebt eine Nachricht in die Unterwarteschlange des Deadletters. (Geerbt von IReceiverClient)
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Empfangen Sie kontinuierlich Nachrichten von der Entität. Registriert einen Nachrichtenhandler und beginnt einen neuen Thread zum Empfangen von Nachrichten. Dieser handler(Func<T1,T2,TResult>) wird jedes Mal erwartet, wenn eine neue Nachricht vom Empfänger empfangen wird. (Geerbt von IReceiverClient)
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions)	Empfangen Sie kontinuierlich Nachrichten von der Entität. Registriert einen Nachrichtenhandler und beginnt einen neuen Thread zum Empfangen von Nachrichten. Dieser handler(Func<T1,T2,TResult>) wird jedes Mal erwartet, wenn eine neue Nachricht vom Empfänger empfangen wird. (Geerbt von IReceiverClient)
RegisterPlugin(ServiceBusPlugin)	Registriert eine ServiceBusPlugin , die mit diesem Client verwendet werden soll. (Geerbt von IClientEntity)
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Empfangen Sie fortlaufend Sitzungsnachrichten aus der Warteschlange. Registriert einen Nachrichtenhandler und beginnt einen neuen Thread zum Empfangen von Sitzungsmeldungen. Dieser handler(Func<T1,T2,T3,TResult>) wird jedes Mal erwartet, wenn eine neue Nachricht vom Warteschlangenclient empfangen wird.
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, SessionHandlerOptions)	Empfangen Sie fortlaufend Sitzungsnachrichten aus der Warteschlange. Registriert einen Nachrichtenhandler und beginnt einen neuen Thread zum Empfangen von Sitzungsmeldungen. Dieser handler(Func<T1,T2,T3,TResult>) wird jedes Mal erwartet, wenn eine neue Nachricht vom Warteschlangenclient empfangen wird.
ScheduleMessageAsync(Message, DateTimeOffset)	Plant die Anzeige einer Nachricht in Service Bus. (Geerbt von ISenderClient)
SendAsync(IList<Message>)	Sendet eine Liste von Nachrichten an Service Bus. Wenn für partitionierte Entitäten aufgerufen wird, können Nachrichten, die für verschiedene Partitionen bestimmt sind, nicht im Batch zusammengefasst werden. (Geerbt von ISenderClient)
SendAsync(Message)	Sendet eine Nachricht an Service Bus. (Geerbt von ISenderClient)
UnregisterMessageHandlerAsync(TimeSpan)	Heben Sie die Registrierung des Nachrichtenhandlers vom Empfänger auf, wenn ein aktiver Nachrichtenhandler registriert ist. Dieser Vorgang wartet darauf, dass der Abschluss von Empfangs- und Nachrichtenverarbeitungsvorgängen an Bord abgeschlossen ist, und hebt die Registrierung zukünftiger Empfänge für den zuvor registrierten Nachrichtenhandler auf. (Geerbt von IReceiverClient)
UnregisterPlugin(String)	Hebt die Registrierung eines auf ServiceBusPlugin. (Geerbt von IClientEntity)
UnregisterSessionHandlerAsync(TimeSpan)	Heben Sie die Registrierung des Sitzungshandlers vom Empfänger auf, wenn ein aktiver Sitzungshandler registriert ist. Dieser Vorgang wartet darauf, dass der Abschluss von Empfangs- und Sitzungsverarbeitungsvorgängen an Bord abgeschlossen ist, und hebt die Registrierung zukünftiger Empfänge auf dem Sitzungshandler auf, der zuvor registriert wurde.

Weitere Informationen

• QueueClient