/
IEventProcessor.xml
103 lines (103 loc) · 8.36 KB
/
IEventProcessor.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<Type Name="IEventProcessor" FullName="Microsoft.ServiceBus.Messaging.IEventProcessor">
<TypeSignature Language="C#" Value="public interface IEventProcessor" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IEventProcessor" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.IEventProcessor" />
<TypeSignature Language="VB.NET" Value="Public Interface IEventProcessor" />
<TypeSignature Language="F#" Value="type IEventProcessor = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>Provides methods for event processors. Applications must implement this interface,
which enables the handling of events from Event Hubs. This interface is the main extensibility point for the
EventProcessorHost and
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.RegisterProcessor``1(Microsoft.ServiceBus.Messaging.Lease,Microsoft.ServiceBus.Messaging.ICheckpointManager)" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CloseAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CloseAsync (Microsoft.ServiceBus.Messaging.PartitionContext context, Microsoft.ServiceBus.Messaging.CloseReason reason);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CloseAsync(class Microsoft.ServiceBus.Messaging.PartitionContext context, valuetype Microsoft.ServiceBus.Messaging.CloseReason reason) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.IEventProcessor.CloseAsync(Microsoft.ServiceBus.Messaging.PartitionContext,Microsoft.ServiceBus.Messaging.CloseReason)" />
<MemberSignature Language="VB.NET" Value="Public Function CloseAsync (context As PartitionContext, reason As CloseReason) As Task" />
<MemberSignature Language="F#" Value="abstract member CloseAsync : Microsoft.ServiceBus.Messaging.PartitionContext * Microsoft.ServiceBus.Messaging.CloseReason -> System.Threading.Tasks.Task" Usage="iEventProcessor.CloseAsync (context, reason)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.ServiceBus.Messaging.PartitionContext" />
<Parameter Name="reason" Type="Microsoft.ServiceBus.Messaging.CloseReason" />
</Parameters>
<Docs>
<param name="context">Partition ownership information for the partition on which this processor instance works. You can call
<see cref="M:Microsoft.ServiceBus.Messaging.PartitionContext.CheckpointAsync" /> to checkpoint progress in the processing of messages from Event Hub streams.</param>
<param name="reason">The reason for calling
<see cref="M:Microsoft.ServiceBus.Messaging.IEventProcessor.CloseAsync(Microsoft.ServiceBus.Messaging.PartitionContext,Microsoft.ServiceBus.Messaging.CloseReason)" />.</param>
<summary>Called when the ownership of partition moves to a different node for load-balancing purpose, or when the host is shutting down. Called in response to
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.UnregisterProcessorAsync(Microsoft.ServiceBus.Messaging.Lease,Microsoft.ServiceBus.Messaging.CloseReason)" />.</summary>
<returns> A task indicating that the Close operation is complete.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OpenAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task OpenAsync (Microsoft.ServiceBus.Messaging.PartitionContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task OpenAsync(class Microsoft.ServiceBus.Messaging.PartitionContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.IEventProcessor.OpenAsync(Microsoft.ServiceBus.Messaging.PartitionContext)" />
<MemberSignature Language="VB.NET" Value="Public Function OpenAsync (context As PartitionContext) As Task" />
<MemberSignature Language="F#" Value="abstract member OpenAsync : Microsoft.ServiceBus.Messaging.PartitionContext -> System.Threading.Tasks.Task" Usage="iEventProcessor.OpenAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.ServiceBus.Messaging.PartitionContext" />
</Parameters>
<Docs>
<param name="context">Ownership information for the partition on which this processor instance works. Any attempt to call
<see cref="M:Microsoft.ServiceBus.Messaging.PartitionContext.CheckpointAsync" /> will fail during the Open operation.</param>
<summary>Initializes the Event Hub processor instance. This method is called before any event data is passed to this processor instance.</summary>
<returns>The task that indicates that the Open operation is complete.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProcessEventsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ProcessEventsAsync (Microsoft.ServiceBus.Messaging.PartitionContext context, System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData> messages);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ProcessEventsAsync(class Microsoft.ServiceBus.Messaging.PartitionContext context, class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.EventData> messages) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.IEventProcessor.ProcessEventsAsync(Microsoft.ServiceBus.Messaging.PartitionContext,System.Collections.Generic.IEnumerable{Microsoft.ServiceBus.Messaging.EventData})" />
<MemberSignature Language="VB.NET" Value="Public Function ProcessEventsAsync (context As PartitionContext, messages As IEnumerable(Of EventData)) As Task" />
<MemberSignature Language="F#" Value="abstract member ProcessEventsAsync : Microsoft.ServiceBus.Messaging.PartitionContext * seq<Microsoft.ServiceBus.Messaging.EventData> -> System.Threading.Tasks.Task" Usage="iEventProcessor.ProcessEventsAsync (context, messages)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.ServiceBus.Messaging.PartitionContext" />
<Parameter Name="messages" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData>" />
</Parameters>
<Docs>
<param name="context">Ownership information for the partition on which this processor instance works.</param>
<param name="messages">A batch of Event Hubs events.</param>
<summary>Asynchronously processes the specified context and messages. This method is called when there are new messages in the
Event Hubs stream. Make sure to checkpoint only when you are finished processing all the events in each batch.</summary>
<returns>The task that indicates that
<see cref="M:Microsoft.ServiceBus.Messaging.IEventProcessor.ProcessEventsAsync(Microsoft.ServiceBus.Messaging.PartitionContext,System.Collections.Generic.IEnumerable{Microsoft.ServiceBus.Messaging.EventData})" /> is complete.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>