-
Notifications
You must be signed in to change notification settings - Fork 255
/
ProcessEventArgs.xml
211 lines (211 loc) · 13.9 KB
/
ProcessEventArgs.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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<Type Name="ProcessEventArgs" FullName="Azure.Messaging.EventHubs.Processor.ProcessEventArgs">
<TypeSignature Language="C#" Value="public struct ProcessEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit ProcessEventArgs extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.Processor.ProcessEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Structure ProcessEventArgs" />
<TypeSignature Language="F#" Value="type ProcessEventArgs = struct" />
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
<AssemblyVersion>5.8.0.0</AssemblyVersion>
<AssemblyVersion>5.8.1.0</AssemblyVersion>
<AssemblyVersion>5.9.0.0</AssemblyVersion>
<AssemblyVersion>5.9.1.0</AssemblyVersion>
<AssemblyVersion>5.9.2.0</AssemblyVersion>
<AssemblyVersion>5.9.3.0</AssemblyVersion>
<AssemblyVersion>5.10.0.0</AssemblyVersion>
<AssemblyVersion>5.11.0.0</AssemblyVersion>
<AssemblyVersion>5.11.1.0</AssemblyVersion>
<AssemblyVersion>5.11.2.0</AssemblyVersion>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains information about a partition that has attempted to receive an event from the Azure Event Hub
service in an <c>EventProcessorClient</c> context, as well as the received event, if any. It
allows creating a checkpoint based on the associated event.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProcessEventArgs (Azure.Messaging.EventHubs.Consumer.PartitionContext partition, Azure.Messaging.EventHubs.EventData data, Func<System.Threading.CancellationToken,System.Threading.Tasks.Task> updateCheckpointImplementation, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.EventHubs.Consumer.PartitionContext partition, class Azure.Messaging.EventHubs.EventData data, class System.Func`2<valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> updateCheckpointImplementation, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.#ctor(Azure.Messaging.EventHubs.Consumer.PartitionContext,Azure.Messaging.EventHubs.EventData,System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (partition As PartitionContext, data As EventData, updateCheckpointImplementation As Func(Of CancellationToken, Task), Optional cancellationToken As CancellationToken = Nothing)" />
<MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Processor.ProcessEventArgs : Azure.Messaging.EventHubs.Consumer.PartitionContext * Azure.Messaging.EventHubs.EventData * Func<System.Threading.CancellationToken, System.Threading.Tasks.Task> * System.Threading.CancellationToken -> Azure.Messaging.EventHubs.Processor.ProcessEventArgs" Usage="new Azure.Messaging.EventHubs.Processor.ProcessEventArgs (partition, data, updateCheckpointImplementation, cancellationToken)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="partition" Type="Azure.Messaging.EventHubs.Consumer.PartitionContext" />
<Parameter Name="data" Type="Azure.Messaging.EventHubs.EventData" />
<Parameter Name="updateCheckpointImplementation" Type="System.Func<System.Threading.CancellationToken,System.Threading.Tasks.Task>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="partition">The context of the Event Hub partition this instance is associated with.</param>
<param name="data">The received event to be processed. Expected to be <c>null</c> if the receive call has timed out.</param>
<param name="updateCheckpointImplementation">The callback to be called upon <see cref="M:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.UpdateCheckpointAsync(System.Threading.CancellationToken)" /> call.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Processor.ProcessEventArgs" /> structure.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CancellationToken">
<MemberSignature Language="C#" Value="public System.Threading.CancellationToken CancellationToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Threading.CancellationToken CancellationToken" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.CancellationToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CancellationToken As CancellationToken" />
<MemberSignature Language="F#" Value="member this.CancellationToken : System.Threading.CancellationToken" Usage="Azure.Messaging.EventHubs.Processor.ProcessEventArgs.CancellationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<summary>
A <see cref="T:System.Threading.CancellationToken" /> to indicate that the processor is requesting that the
handler stop its activities. If this token is requesting cancellation, then either the processor is
attempting to shutdown or ownership of the partition has changed.
</summary>
<value>To be added.</value>
<remarks>
The handler processing events has responsibility for deciding whether or not to honor
the cancellation request. If the application chooses not to do so, the processor will wait for the
handler to complete before taking further action.
</remarks>
</Docs>
</Member>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public Azure.Messaging.EventHubs.EventData Data { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Messaging.EventHubs.EventData Data" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.Data" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Data As EventData" />
<MemberSignature Language="F#" Value="member this.Data : Azure.Messaging.EventHubs.EventData" Usage="Azure.Messaging.EventHubs.Processor.ProcessEventArgs.Data" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.EventHubs.EventData</ReturnType>
</ReturnValue>
<Docs>
<summary>
The received event to be processed. Expected to be <c>null</c> if the receive call has timed out.
</summary>
<value>To be added.</value>
<remarks>
Ownership of this data, including the memory that holds its <see cref="P:Azure.Messaging.EventHubs.EventData.EventBody" />,
is assumed to transfer to consumers of the <see cref="T:Azure.Messaging.EventHubs.Processor.ProcessEventArgs" />. It may be considered
immutable and is safe to access so long as the reference is held.
</remarks>
</Docs>
</Member>
<Member MemberName="HasEvent">
<MemberSignature Language="C#" Value="public bool HasEvent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasEvent" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.HasEvent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasEvent As Boolean" />
<MemberSignature Language="F#" Value="member this.HasEvent : bool" Usage="Azure.Messaging.EventHubs.Processor.ProcessEventArgs.HasEvent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates whether or not the arguments contain an event to be processed. In
the case where no event is contained, then the creation of checkpoints and reading the last
enqueued event properties are unavailable.
</summary>
<value>
<c>true</c> if the arguments contain an event to be processed; otherwise, <c>false</c>.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Partition">
<MemberSignature Language="C#" Value="public Azure.Messaging.EventHubs.Consumer.PartitionContext Partition { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Messaging.EventHubs.Consumer.PartitionContext Partition" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.Partition" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Partition As PartitionContext" />
<MemberSignature Language="F#" Value="member this.Partition : Azure.Messaging.EventHubs.Consumer.PartitionContext" Usage="Azure.Messaging.EventHubs.Processor.ProcessEventArgs.Partition" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.EventHubs.Consumer.PartitionContext</ReturnType>
</ReturnValue>
<Docs>
<summary>
The context of the Event Hub partition this instance is associated with.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateCheckpointAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task UpdateCheckpointAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task UpdateCheckpointAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.UpdateCheckpointAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function UpdateCheckpointAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.UpdateCheckpointAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="processEventArgs.UpdateCheckpointAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Updates the checkpoint for the <see cref="T:Azure.Messaging.EventHubs.Consumer.PartitionContext" /> and <see cref="T:Azure.Messaging.EventHubs.EventData" /> associated with
this event.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Occurs when <see cref="P:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.Partition" /> and <see cref="P:Azure.Messaging.EventHubs.Processor.ProcessEventArgs.Data" /> are <c>null</c>.</exception>
</Docs>
</Member>
</Members>
</Type>