ClientEntity Class
Definition
Contract for all client entities with Open-Close/Abort state m/c main-purpose: closeAll related entities
public abstract class ClientEntity : Microsoft.Azure.ServiceBus.IClientEntitytype ClientEntity = class
interface IClientEntityPublic MustInherit Class ClientEntity
Implements IClientEntity- Inheritance
-
ClientEntity
- Derived
- Implements
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. |
| RegisteredPlugins |
Gets a list of currently registered plugins for this client. |
| RetryPolicy |
Gets the RetryPolicy defined on the client. |
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. |