Event​Hub​Client Class

Definition

An anchor class used to send and receive events to and from an Event Hub.

public abstract class EventHubClient : Microsoft.ServiceBus.Messaging.ClientEntity
Inheritance
EventHubClient

Inherited Members

Microsoft.ServiceBus.Messaging.ClientEntity

Properties

Path

Gets the path of the Event Hub.

Prefetch​Count

Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from MessagingFactory if the current instance is created from the factory method. Otherwise, the default value is 10,000.

Prefetch​Size​In​Bytes

Gets or sets the maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the SerializedSizeInBytes property.

Methods

Create(​String)

Creates a new instance of the EventHubClient instance, using a connection string from the application configuration settings.

Create​Batch()

Creates a batch where event data objects can be added for later SendBatch or SendBatchAsync call.

Create​From​Connection​String(​String)

Creates a new instance of the Event Hubs client using the specified connection string. You can populate the EntityPath property with the name of the Event Hub.

Create​From​Connection​String(​String, ​String)

Creates a new instance of the Event Hubs client using the specified connection string. Use this overload only when the connection string does not use the EntityPath property.

Create​Partitioned​Sender(​String)

Creates an Event Hubs sender for the specified Event Hubs partition.

Create​Partitioned​Sender​Async(​String)

Asynchronous version of CreatePartitionedSender(String).

Create​Sender(​String)

Creates an Event Hubs sender for the specified publisher.

Create​Sender​Async()

Creates the Event Hubs sender. This method is for internal use, and not meant to be called from user code.

Create​Sender​Async(​String)

Asynchronous version of CreateSender(String).

Get​Consumer​Group(​String)

Returns the consumer group with the specified name, for the receive operation of event data.

Get​Default​Consumer​Group()

Returns the default consumer group, for the receive operation of event data.

Get​Partition​Runtime​Information(​String)

Retrieves runtime information for the specified partition of the Event Hub.

Get​Partition​Runtime​Information​Async(​String)

Asynchronous version of GetPartitionRuntimeInformation(String).

Get​Runtime​Information()

Retrieves Event Hubs runtime information, which is required for creating EventHubSender or EventHubReceiver objects.

Get​Runtime​Information​Async()

Asynchronous version of GetRuntimeInformation().

On​Abort()

Executes the abort action.

On​Begin​Close(​Time​Span, ​Async​Callback, ​Object)

Executes the begin close action.

On​Begin​Open(​Time​Span, ​Async​Callback, ​Object)

Executes the begin open action.

On​Close(​Time​Span)

Executes the close action.

On​End​Close(​IAsync​Result)

Executes the end close action.

On​End​Open(​IAsync​Result)

Executes the end open action.

Send(​Event​Data)

Sends event data to an Event Hub.

Send​Async(​Event​Data)

Asynchronously sends event data to an Event Hub.

Send​Batch(​IEnumerable<​Event​Data>)

Sends a batch of event data.

Send​Batch​Async(​IEnumerable<​Event​Data>)

Asynchronously sends a batch of event data.

Extension Methods

IsDefined(Object)

An anchor class used to send and receive events to and from an Event Hub.

IsNull(Object)

An anchor class used to send and receive events to and from an Event Hub.

IsPrimitive(Object)

An anchor class used to send and receive events to and from an Event Hub.