xml/Microsoft.Azure.EventHubs/PartitionReceiver.xml

<Type Name="PartitionReceiver" FullName="Microsoft.Azure.EventHubs.PartitionReceiver"> <TypeSignature Language="C#" Value="public abstract class PartitionReceiver : Microsoft.Azure.EventHubs.ClientEntity" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PartitionReceiver extends Microsoft.Azure.EventHubs.ClientEntity" /> <TypeSignature Language="DocId" Value="T:Microsoft.Azure.EventHubs.PartitionReceiver" /> <TypeSignature Language="VB.NET" Value="Public MustInherit Class PartitionReceiver
Inherits ClientEntity" /> <TypeSignature Language="F#" Value="type PartitionReceiver = class
 inherit ClientEntity" /> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.1.0</AssemblyVersion> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>Microsoft.Azure.EventHubs.ClientEntity</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> This is a logical representation of receiving from a EventHub partition. <para> A PartitionReceiver is tied to a ConsumerGroup + Partition combination. If you are creating an epoch based PartitionReceiver (i.e. PartitionReceiver.Epoch != 0) you cannot have more than one active receiver per ConsumerGroup + Partition combo. You can have multiple receivers per ConsumerGroup + Partition combination with non-epoch receivers. </para></summary> <remarks>To be added.</remarks> <altmember cref="M:Microsoft.Azure.EventHubs.EventHubClient.CreateReceiver(System.String,System.String,Microsoft.Azure.EventHubs.EventPosition,Microsoft.Azure.EventHubs.ReceiverOptions)" /> <altmember cref="M:Microsoft.Azure.EventHubs.EventHubClient.CreateEpochReceiver(System.String,System.String,Microsoft.Azure.EventHubs.EventPosition,System.Int64,Microsoft.Azure.EventHubs.ReceiverOptions)" /> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected PartitionReceiver (Microsoft.Azure.EventHubs.EventHubClient eventHubClient, string consumerGroupName, string partitionId, Microsoft.Azure.EventHubs.EventPosition eventPosition, long? epoch, Microsoft.Azure.EventHubs.ReceiverOptions receiverOptions);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.EventHubs.EventHubClient eventHubClient, string consumerGroupName, string partitionId, class Microsoft.Azure.EventHubs.EventPosition eventPosition, valuetype System.Nullable`1<int64> epoch, class Microsoft.Azure.EventHubs.ReceiverOptions receiverOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.#ctor(Microsoft.Azure.EventHubs.EventHubClient,System.String,System.String,Microsoft.Azure.EventHubs.EventPosition,System.Nullable{System.Int64},Microsoft.Azure.EventHubs.ReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Protected Sub New (eventHubClient As EventHubClient, consumerGroupName As String, partitionId As String, eventPosition As EventPosition, epoch As Nullable(Of Long), receiverOptions As ReceiverOptions)" /> <MemberSignature Language="F#" Value="new Microsoft.Azure.EventHubs.PartitionReceiver : Microsoft.Azure.EventHubs.EventHubClient * string * string * Microsoft.Azure.EventHubs.EventPosition * Nullable<int64> * Microsoft.Azure.EventHubs.ReceiverOptions -> Microsoft.Azure.EventHubs.PartitionReceiver" Usage="new Microsoft.Azure.EventHubs.PartitionReceiver (eventHubClient, consumerGroupName, partitionId, eventPosition, epoch, receiverOptions)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="eventHubClient" Type="Microsoft.Azure.EventHubs.EventHubClient" /> <Parameter Name="consumerGroupName" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Microsoft.Azure.EventHubs.EventPosition" /> <Parameter Name="epoch" Type="System.Nullable<System.Int64>" /> <Parameter Name="receiverOptions" Type="Microsoft.Azure.EventHubs.ReceiverOptions" /> </Parameters> <Docs> <param name="eventHubClient" /> <param name="consumerGroupName" /> <param name="partitionId" /> <param name="eventPosition" /> <param name="epoch" /> <param name="receiverOptions" /> <summary /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CloseAsync"> <MemberSignature Language="C#" Value="public override sealed System.Threading.Tasks.Task CloseAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task CloseAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.CloseAsync" /> <MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable Function CloseAsync () As Task" /> <MemberSignature Language="F#" Value="override this.CloseAsync : unit -> System.Threading.Tasks.Task" Usage="partitionReceiver.CloseAsync " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Closes and releases resources associated with <see cref="T:Microsoft.Azure.EventHubs.PartitionReceiver" />. </summary> <returns>An asynchronous operation</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ConsumerGroupName"> <MemberSignature Language="C#" Value="public string ConsumerGroupName { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string ConsumerGroupName" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.ConsumerGroupName" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ConsumerGroupName As String" /> <MemberSignature Language="F#" Value="member this.ConsumerGroupName : string" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.ConsumerGroupName" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The Consumer Group Name </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DefaultConsumerGroupName"> <MemberSignature Language="C#" Value="public static readonly string DefaultConsumerGroupName;" /> <MemberSignature Language="ILAsm" Value=".field public static initonly string DefaultConsumerGroupName" /> <MemberSignature Language="DocId" Value="F:Microsoft.Azure.EventHubs.PartitionReceiver.DefaultConsumerGroupName" /> <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly DefaultConsumerGroupName As String " /> <MemberSignature Language="F#" Value=" staticval mutable DefaultConsumerGroupName : string" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.DefaultConsumerGroupName" /> <MemberType>Field</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The default consumer group name: $Default. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Epoch"> <MemberSignature Language="C#" Value="public long? Epoch { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> Epoch" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.Epoch" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Epoch As Nullable(Of Long)" /> <MemberSignature Language="F#" Value="member this.Epoch : Nullable<int64>" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.Epoch" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Nullable<System.Int64></ReturnType> </ReturnValue> <Docs> <summary> Get the epoch value that this receiver is currently using for partition ownership. <para>A value of null means this receiver is not an epoch-based receiver.</para></summary> <value>the epoch value that this receiver is currently using for partition ownership.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="EventHubClient"> <MemberSignature Language="C#" Value="public Microsoft.Azure.EventHubs.EventHubClient EventHubClient { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.EventHubs.EventHubClient EventHubClient" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.EventHubClient" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventHubClient As EventHubClient" /> <MemberSignature Language="F#" Value="member this.EventHubClient : Microsoft.Azure.EventHubs.EventHubClient" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.EventHubClient" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.EventHubs.EventHubClient</ReturnType> </ReturnValue> <Docs> <summary> The EventHubClient this PartitionReceiver was created from. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="EventPosition"> <MemberSignature Language="C#" Value="protected Microsoft.Azure.EventHubs.EventPosition EventPosition { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.EventHubs.EventPosition EventPosition" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.EventPosition" /> <MemberSignature Language="VB.NET" Value="Protected Property EventPosition As EventPosition" /> <MemberSignature Language="F#" Value="member this.EventPosition : Microsoft.Azure.EventHubs.EventPosition with get, set" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.EventPosition" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.EventHubs.EventPosition</ReturnType> </ReturnValue> <Docs> <summary /> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Identifier"> <MemberSignature Language="C#" Value="public string Identifier { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string Identifier" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.Identifier" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Identifier As String" /> <MemberSignature Language="F#" Value="member this.Identifier : string" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.Identifier" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary>Gets the identifier of a receiver which was set during the creation of the receiver.</summary> <value>A string representing the identifier of a receiver. It will return null if the identifier is not set.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnCloseAsync"> <MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task OnCloseAsync ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnCloseAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.OnCloseAsync" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnCloseAsync () As Task" /> <MemberSignature Language="F#" Value="abstract member OnCloseAsync : unit -> System.Threading.Tasks.Task" Usage="partitionReceiver.OnCloseAsync " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary /> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnReceiveAsync"> <MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.EventHubs.EventData>> OnReceiveAsync (int maxMessageCount, TimeSpan waitTime);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.EventHubs.EventData>> OnReceiveAsync(int32 maxMessageCount, valuetype System.TimeSpan waitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.OnReceiveAsync(System.Int32,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnReceiveAsync (maxMessageCount As Integer, waitTime As TimeSpan) As Task(Of IList(Of EventData))" /> <MemberSignature Language="F#" Value="abstract member OnReceiveAsync : int * TimeSpan -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.EventHubs.EventData>>" Usage="partitionReceiver.OnReceiveAsync (maxMessageCount, waitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.EventHubs.EventData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxMessageCount" Type="System.Int32" /> <Parameter Name="waitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="maxMessageCount" /> <param name="waitTime" /> <summary /> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnSetReceiveHandler"> <MemberSignature Language="C#" Value="protected abstract void OnSetReceiveHandler (Microsoft.Azure.EventHubs.IPartitionReceiveHandler receiveHandler, bool invokeWhenNoEvents);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnSetReceiveHandler(class Microsoft.Azure.EventHubs.IPartitionReceiveHandler receiveHandler, bool invokeWhenNoEvents) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.OnSetReceiveHandler(Microsoft.Azure.EventHubs.IPartitionReceiveHandler,System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Sub OnSetReceiveHandler (receiveHandler As IPartitionReceiveHandler, invokeWhenNoEvents As Boolean)" /> <MemberSignature Language="F#" Value="abstract member OnSetReceiveHandler : Microsoft.Azure.EventHubs.IPartitionReceiveHandler * bool -> unit" Usage="partitionReceiver.OnSetReceiveHandler (receiveHandler, invokeWhenNoEvents)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="receiveHandler" Type="Microsoft.Azure.EventHubs.IPartitionReceiveHandler" /> <Parameter Name="invokeWhenNoEvents" Type="System.Boolean" /> </Parameters> <Docs> <param name="receiveHandler" /> <param name="invokeWhenNoEvents" /> <summary /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PartitionId"> <MemberSignature Language="C#" Value="public string PartitionId { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string PartitionId" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.PartitionId" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property PartitionId As String" /> <MemberSignature Language="F#" Value="member this.PartitionId : string" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.PartitionId" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> Get the EventHub partition identifier. </summary> <value>The identifier representing the partition from which this receiver is fetching data</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PrefetchCount"> <MemberSignature Language="C#" Value="public int PrefetchCount { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.PrefetchCount" /> <MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" /> <MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.PrefetchCount" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary> Get Prefetch Count configured on the Receiver. </summary> <value>The upper limit of events this receiver will actively receive regardless of whether a receive operation is pending.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.EventHubs.EventData>> ReceiveAsync (int maxMessageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.EventHubs.EventData>> ReceiveAsync(int32 maxMessageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.ReceiveAsync(System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (maxMessageCount As Integer) As Task(Of IEnumerable(Of EventData))" /> <MemberSignature Language="F#" Value="member this.ReceiveAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.Azure.EventHubs.EventData>>" Usage="partitionReceiver.ReceiveAsync maxMessageCount" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.EventHubs.EventData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxMessageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="maxMessageCount">To be added.</param> <summary> Receive a batch of <see cref="T:Microsoft.Azure.EventHubs.EventData" />'s from an EventHub partition </summary> <returns>A Task that will yield a batch of <see cref="T:Microsoft.Azure.EventHubs.EventData" /> from the partition on which this receiver is created. Returns 'null' if no EventData is present.</returns> <remarks>To be added.</remarks> <example> Sample code: <code> EventHubClient client = EventHubClient.Create("__connectionString__"); PartitionReceiver receiver = client.CreateReceiver("ConsumerGroup1", "1"); IEnumerable<EventData> receivedEvents = await receiver.ReceiveAsync(BatchSize); while (true) { int batchSize = 0; if (receivedEvents != null) { foreach (EventData receivedEvent in receivedEvents) { Console.WriteLine("Message Payload: {0}", Encoding.UTF8.GetString(receivedEvent.Body)); Console.WriteLine("Offset: {0}, SeqNo: {1}, EnqueueTime: {2}", receivedEvent.SystemProperties.Offset, receivedEvent.SystemProperties.SequenceNumber, receivedEvent.SystemProperties.EnqueuedTime); batchSize++; } } Console.WriteLine("ReceivedBatch Size: {0}", batchSize); receivedEvents = await receiver.ReceiveAsync(); } </code></example> </Docs> </Member> <Member MemberName="ReceiveAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.EventHubs.EventData>> ReceiveAsync (int maxMessageCount, TimeSpan waitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.EventHubs.EventData>> ReceiveAsync(int32 maxMessageCount, valuetype System.TimeSpan waitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.ReceiveAsync(System.Int32,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (maxMessageCount As Integer, waitTime As TimeSpan) As Task(Of IEnumerable(Of EventData))" /> <MemberSignature Language="F#" Value="member this.ReceiveAsync : int * TimeSpan -> System.Threading.Tasks.Task<seq<Microsoft.Azure.EventHubs.EventData>>" Usage="partitionReceiver.ReceiveAsync (maxMessageCount, waitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.EventHubs.EventData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxMessageCount" Type="System.Int32" /> <Parameter Name="waitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="maxMessageCount">To be added.</param> <param name="waitTime">To be added.</param> <summary> Receive a batch of <see cref="T:Microsoft.Azure.EventHubs.EventData" />'s from an EventHub partition by allowing wait time on each individual call. </summary> <returns>A Task that will yield a batch of <see cref="T:Microsoft.Azure.EventHubs.EventData" /> from the partition on which this receiver is created. Returns 'null' if no EventData is present.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiverRuntimeMetricEnabled"> <MemberSignature Language="C#" Value="public bool ReceiverRuntimeMetricEnabled { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool ReceiverRuntimeMetricEnabled" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.ReceiverRuntimeMetricEnabled" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ReceiverRuntimeMetricEnabled As Boolean" /> <MemberSignature Language="F#" Value="member this.ReceiverRuntimeMetricEnabled : bool" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.ReceiverRuntimeMetricEnabled" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> <summary> Gets a value indicating whether the runtime metric of a receiver is enabled. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RuntimeInfo"> <MemberSignature Language="C#" Value="public Microsoft.Azure.EventHubs.ReceiverRuntimeInformation RuntimeInfo { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.EventHubs.ReceiverRuntimeInformation RuntimeInfo" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.PartitionReceiver.RuntimeInfo" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property RuntimeInfo As ReceiverRuntimeInformation" /> <MemberSignature Language="F#" Value="member this.RuntimeInfo : Microsoft.Azure.EventHubs.ReceiverRuntimeInformation" Usage="Microsoft.Azure.EventHubs.PartitionReceiver.RuntimeInfo" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.EventHubs.ReceiverRuntimeInformation</ReturnType> </ReturnValue> <Docs> <summary> Gets the approximate receiver runtime information for a logical partition of an Event Hub. To enable the setting, refer to <see cref="T:Microsoft.Azure.EventHubs.ReceiverOptions" /> and <see cref="P:Microsoft.Azure.EventHubs.EventHubClient.EnableReceiverRuntimeMetric" /></summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SetReceiveHandler"> <MemberSignature Language="C#" Value="public void SetReceiveHandler (Microsoft.Azure.EventHubs.IPartitionReceiveHandler receiveHandler, bool invokeWhenNoEvents = false);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetReceiveHandler(class Microsoft.Azure.EventHubs.IPartitionReceiveHandler receiveHandler, bool invokeWhenNoEvents) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.PartitionReceiver.SetReceiveHandler(Microsoft.Azure.EventHubs.IPartitionReceiveHandler,System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Public Sub SetReceiveHandler (receiveHandler As IPartitionReceiveHandler, Optional invokeWhenNoEvents As Boolean = false)" /> <MemberSignature Language="F#" Value="member this.SetReceiveHandler : Microsoft.Azure.EventHubs.IPartitionReceiveHandler * bool -> unit" Usage="partitionReceiver.SetReceiveHandler (receiveHandler, invokeWhenNoEvents)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.EventHubs</AssemblyName> <AssemblyVersion>4.3.2.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="receiveHandler" Type="Microsoft.Azure.EventHubs.IPartitionReceiveHandler" /> <Parameter Name="invokeWhenNoEvents" Type="System.Boolean" /> </Parameters> <Docs> <param name="receiveHandler">The <see cref="T:Microsoft.Azure.EventHubs.IPartitionReceiveHandler" /> used to process events.</param> <param name="invokeWhenNoEvents">Flag to indicate whether the handler should be invoked when the receive call times out.</param> <summary> Sets the <see cref="T:Microsoft.Azure.EventHubs.IPartitionReceiveHandler" /> to process events. </summary> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Microsoft.Azure.EventHubs/PartitionReceiver.xml (475 lines of code) (raw):