EventHubReceiver 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
type EventHubReceiver = class
    inherit ClientEntity
Public NotInheritable Class EventHubReceiver
Inherits ClientEntity
Inheritance
System.Object
EventHubReceiver

Properties

Epoch

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

EventHubPath

Gets the event hub path.

Identifier

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

IsClosed (Inherited from ClientEntity)
Name

Gets the name of the Event Hub.

OffsetInclusive

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.

PartitionId

Gets the partition ID for a logical partition of an Event Hub.

PrefetchCount

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.

PrefetchSizeInBytes

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.

ReceiverRuntimeMetricEnabled

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

RetryPolicy (Inherited from ClientEntity)
RuntimeInfo

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

StartingDateTimeUtc

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.

StartingOffset

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.

StartingSequenceNumber

Gets the starting sequence number for this receiver. The Receive() method starts receiving the next event after this StartingSequenceNumber value.

ThisLock (Inherited from ClientEntity)

Methods

Abort()

Performs abort functionality on the messaging entity.

(Inherited from ClientEntity)
Close()

Sends a cleanup message to Service Bus to signal the completion of the usage of an entity.

(Inherited from ClientEntity)
CloseAsync()

Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity.

(Inherited from ClientEntity)
Fault()

For internal use only. Do not inherit from this class.

(Inherited from ClientEntity)
OnAbort() (Inherited from ClientEntity)
OnBeginClose(TimeSpan, AsyncCallback, Object) (Inherited from ClientEntity)
OnBeginOpen(TimeSpan, AsyncCallback, Object) (Inherited from ClientEntity)
OnClose(TimeSpan) (Inherited from ClientEntity)
OnClosed() (Inherited from ClientEntity)
OnEndClose(IAsyncResult) (Inherited from ClientEntity)
OnEndOpen(IAsyncResult) (Inherited from ClientEntity)
OnFaulted() (Inherited from ClientEntity)
OnOpen(TimeSpan) (Inherited from ClientEntity)
OnOpened() (Inherited from ClientEntity)
Receive()

Receives Event Hubs event data.

Receive(Int32)

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

Receive(Int32, TimeSpan)

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

Receive(TimeSpan)

Receives Event Hubs event data with the specified timeout value.

ReceiveAsync()

Asynchronous version of Receive().

ReceiveAsync(Int32)

Asynchronous version of Receive(Int32).

ReceiveAsync(Int32, TimeSpan)

Asynchronous version of Receive(Int32, TimeSpan).

ReceiveAsync(TimeSpan)

Asynchronous version of Receive(TimeSpan).

ThrowIfClosed() (Inherited from ClientEntity)
ThrowIfDisposed() (Inherited from ClientEntity)
ThrowIfDisposedOrImmutable() (Inherited from ClientEntity)
ThrowIfDisposedOrNotOpen() (Inherited from ClientEntity)
ThrowIfFaulted() (Inherited from ClientEntity)

Applies to