ClientEntity Class

Reference

Definition

Namespace:: Microsoft.Azure.ServiceBus

Assembly:: Microsoft.Azure.ServiceBus.dll

Package:: Microsoft.Azure.ServiceBus v5.2.0

Source:: ClientEntity.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contract for all client entities with Open-Close/Abort state m/c main-purpose: closeAll related entities

public abstract class ClientEntity : Microsoft.Azure.ServiceBus.IClientEntity

type ClientEntity = class
    interface IClientEntity

Public MustInherit Class ClientEntity
Implements IClientEntity

Inheritance: Object
ClientEntity

Derived: Microsoft.Azure.ServiceBus.Core.MessageReceiver

Microsoft.Azure.ServiceBus.Core.MessageSender

Microsoft.Azure.ServiceBus.QueueClient

Microsoft.Azure.ServiceBus.SessionClient

Microsoft.Azure.ServiceBus.SubscriptionClient

More…

Implements: IClientEntity

Constructors

ClientEntity(String, String, RetryPolicy)

Properties

ClientId	Gets the ID to identify this client. This can be used to correlate logs and exceptions.
IsClosedOrClosing	Returns true if the client is closed or closing.
OperationTimeout	Duration after which individual operations will timeout.
OwnsConnection	Returns true if connection is owned and false if connection is shared.
Path	Gets the name of the entity.
RegisteredPlugins	Gets a list of currently registered plugins for this client.
RetryPolicy	Gets the RetryPolicy defined on the client.
ServiceBusConnection	Connection object to the service bus namespace.

Methods

CloseAsync()	Closes the Client. Closes the connections opened by it.
GenerateClientId(String, String)	Generates a new client id that can be used to identify a specific client in logs and error messages.
GetNextId()
OnClosingAsync()
RegisterPlugin(ServiceBusPlugin)	Registers a ServiceBusPlugin to be used with this client.
ThrowIfClosed()	Throw an OperationCanceledException if the object is Closing.
UnregisterPlugin(String)	Unregisters a ServiceBusPlugin.

Applies to