EventHubReceiver EventHubReceiver 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
EventHubReceiverEventHubReceiverEventHubReceiver

Properties

Epoch Epoch Epoch

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

EventHubPath EventHubPath EventHubPath

Gets the event hub path.

Identifier Identifier Identifier

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

IsClosed IsClosed IsClosed Inherited from ClientEntity
Name Name Name

Gets the name of the Event Hub.

OffsetInclusive OffsetInclusive 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 PartitionId PartitionId

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

PrefetchCount PrefetchCount 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 PrefetchSizeInBytes 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 ReceiverRuntimeMetricEnabled ReceiverRuntimeMetricEnabled

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

RetryPolicy RetryPolicy RetryPolicy Inherited from ClientEntity
RuntimeInfo RuntimeInfo 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 StartingDateTimeUtc 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 StartingOffset 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 StartingSequenceNumber StartingSequenceNumber

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

ThisLock ThisLock ThisLock Inherited from ClientEntity

Methods

Abort() Abort() Abort()

Performs abort functionality on the messaging entity.

(Inherited from ClientEntity)
Close() Close() Close()

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

(Inherited from ClientEntity)
CloseAsync() CloseAsync() CloseAsync()

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

(Inherited from ClientEntity)
Fault() Fault() Fault()

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

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

Receives Event Hubs event data.

Receive(Int32) Receive(Int32) Receive(Int32)

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

Receive(Int32, TimeSpan) Receive(Int32, TimeSpan) Receive(Int32, TimeSpan)

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

Receive(TimeSpan) Receive(TimeSpan) Receive(TimeSpan)

Receives Event Hubs event data with the specified timeout value.

ReceiveAsync() ReceiveAsync() ReceiveAsync()

Asynchronous version of Receive().

ReceiveAsync(Int32) ReceiveAsync(Int32) ReceiveAsync(Int32)

Asynchronous version of Receive(Int32).

ReceiveAsync(Int32, TimeSpan) ReceiveAsync(Int32, TimeSpan) ReceiveAsync(Int32, TimeSpan)

Asynchronous version of Receive(Int32, TimeSpan).

ReceiveAsync(TimeSpan) ReceiveAsync(TimeSpan) ReceiveAsync(TimeSpan)

Asynchronous version of Receive(TimeSpan).

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

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to