Event​Hub​Receiver Class

Definition

A client class used in receive operations related to an Event Hub consumer group. Represents a logical receiver connection to a specific Event Hub partition within a consumer group.

public sealed class EventHubReceiver : Microsoft.ServiceBus.Messaging.ClientEntity
Inheritance
EventHubReceiver

Inherited Members

Microsoft.ServiceBus.Messaging.ClientEntity

Properties

Epoch

Gets the epoch value that is used to determine partition ownership during the receive operation.

Event​Hub​Path

Gets the event hub path.

Identifier

Gets the identifier of a receiver which was set during the creation of the receiver.

Name

Gets the name of the Event Hub.

Offset​Inclusive

Gets a value indicating whether StartingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

Partition​Id

Gets the partition ID for a logical partition of an 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 EventHubConsumerGroup. The default value is 300.

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.

Receiver​Runtime​Metric​Enabled

Gets a value indicating whether the runtime metric of a receiver is enabled.

Runtime​Info

Gets the approximate receiver runtime information for a logical partition of an Event Hub. To enable the setting, refer to ReceiverOptions and EnableReceiverRuntimeMetric

Starting​Date​Time​Utc

Gets the starting date and time in UTC format for this receiver. The Receive() method starts receiving the next event after this StartingDateTimeUtc value. If null, the receiver starts receiving events from the beginning of the Event Hubs event stream.

Starting​Offset

Gets the starting offset for this receiver. The Receive() method starts receiving the next event after this offset value. If the value is null, the receiver starts receiving events from the beginning of the Event Hubs event stream.

Methods

Receive()

Receives Event Hubs event data.

Receive(​Int32)

Receives Event Hubs event data, up to the specified count.

Receive(​Time​Span)

Receives Event Hubs event data with the specified timeout value.

Receive(​Int32, ​Time​Span)

Receives Event Hubs event data, up to the specified count with the specified timeout value.

Receive​Async()

Asynchronous version of Receive().

Receive​Async(​Int32)

Asynchronous version of Receive(Int32).

Receive​Async(​Time​Span)

Asynchronous version of Receive(TimeSpan).

Receive​Async(​Int32, ​Time​Span)

Asynchronous version of Receive(Int32, TimeSpan).

Extension Methods

IsDefined(Object)

A client class used in receive operations related to an Event Hub consumer group. Represents a logical receiver connection to a specific Event Hub partition within a consumer group.

IsNull(Object)

A client class used in receive operations related to an Event Hub consumer group. Represents a logical receiver connection to a specific Event Hub partition within a consumer group.

IsPrimitive(Object)

A client class used in receive operations related to an Event Hub consumer group. Represents a logical receiver connection to a specific Event Hub partition within a consumer group.