Interface IClientEntity

Namespace

Microsoft.Azure.ServiceBus

Assembly

Microsoft.Azure.ServiceBus.dll

An interface showing the common functionality between all Service Bus clients.

public interface IClientEntity

Properties

ClientId

Gets the ID to identify this client. This can be used to correlate logs and exceptions.

string ClientId { get; }

Property Value

string

Remarks

Every new client has a unique ID (in that process).

IsClosedOrClosing

Returns true if the client is closed or closing.

bool IsClosedOrClosing { get; }

Property Value

bool

OperationTimeout

Duration after which individual operations will timeout.

TimeSpan OperationTimeout { get; set; }

Property Value

TimeSpan

Path

Gets the entity path.

string Path { get; }

Property Value

string

RegisteredPlugins

Gets a list of currently registered plugins for this client.

IList<ServiceBusPlugin> RegisteredPlugins { get; }

Property Value

IList<ServiceBusPlugin>

ServiceBusConnection

Connection object to the service bus namespace.

ServiceBusConnection ServiceBusConnection { get; }

Property Value

ServiceBusConnection

Methods

CloseAsync()

Closes the Client. Closes the connections opened by it.

Task CloseAsync()

Returns

Task

RegisterPlugin(ServiceBusPlugin)

Registers a ServiceBusPlugin to be used with this client.

void RegisterPlugin(ServiceBusPlugin serviceBusPlugin)

Parameters

serviceBusPlugin ServiceBusPlugin

The ServiceBusPlugin to register.

UnregisterPlugin(string)

Unregisters a ServiceBusPlugin.

void UnregisterPlugin(string serviceBusPluginName)

Parameters

serviceBusPluginName string

The name Name to be unregistered