ClientEntity Class

Reference

Definition

Namespace:: Microsoft.Azure.EventHubs

Assembly:: Microsoft.Azure.EventHubs.dll

Package:: Microsoft.Azure.EventHubs v4.3.2

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

type ClientEntity = class

Public MustInherit Class ClientEntity

Inheritance: Object
ClientEntity

Derived: Microsoft.Azure.EventHubs.EventHubClient

Microsoft.Azure.EventHubs.PartitionReceiver

Microsoft.Azure.EventHubs.PartitionSender

Constructors

ClientEntity(String)

Properties

ClientId	Gets the client ID.
IsClosed	Returns a boolean representing whether client object is closed or not.
RegisteredPlugins	Gets a list of currently registered plugins for this Client.
RetryPolicy	Gets the RetryPolicy for the ClientEntity.

Methods

Close()	Closes the ClientEntity.
CloseAsync()	Closes the ClientEntity.
GetNextId()
OnRetryPolicyUpdate()	Derived entity to override for retry policy updates.
RegisterPlugin(EventHubsPlugin)	Registers a EventHubsPlugin to be used with this client.
ThrowIfClosed()	Throws an exception if client object is already closed.
UnregisterPlugin(String)	Unregisters a EventHubsPlugin.

Applies to