-
Notifications
You must be signed in to change notification settings - Fork 261
/
ProcessSessionEventArgs.xml
376 lines (376 loc) · 24.3 KB
/
ProcessSessionEventArgs.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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<Type Name="ProcessSessionEventArgs" FullName="Azure.Messaging.ServiceBus.ProcessSessionEventArgs">
<TypeSignature Language="C#" Value="public class ProcessSessionEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProcessSessionEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.ServiceBus.ProcessSessionEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class ProcessSessionEventArgs
Inherits EventArgs" />
<TypeSignature Language="F#" Value="type ProcessSessionEventArgs = class
 inherit EventArgs" />
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.1.2.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
<AssemblyVersion>7.2.1.0</AssemblyVersion>
<AssemblyVersion>7.3.0.0</AssemblyVersion>
<AssemblyVersion>7.4.0.0</AssemblyVersion>
<AssemblyVersion>7.5.0.0</AssemblyVersion>
<AssemblyVersion>7.5.1.0</AssemblyVersion>
<AssemblyVersion>7.6.0.0</AssemblyVersion>
<AssemblyVersion>7.7.0.0</AssemblyVersion>
<AssemblyVersion>7.8.0.0</AssemblyVersion>
<AssemblyVersion>7.8.1.0</AssemblyVersion>
<AssemblyVersion>7.9.0.0</AssemblyVersion>
<AssemblyVersion>7.10.0.0</AssemblyVersion>
<AssemblyVersion>7.11.0.0</AssemblyVersion>
<AssemblyVersion>7.11.1.0</AssemblyVersion>
<AssemblyVersion>7.12.0.0</AssemblyVersion>
<AssemblyVersion>7.13.0.0</AssemblyVersion>
<AssemblyVersion>7.13.1.0</AssemblyVersion>
<AssemblyVersion>7.14.0.0</AssemblyVersion>
<AssemblyVersion>7.15.0.0</AssemblyVersion>
<AssemblyVersion>7.16.0.0</AssemblyVersion>
<AssemblyVersion>7.16.1.0</AssemblyVersion>
<AssemblyVersion>7.16.2.0</AssemblyVersion>
<AssemblyVersion>7.17.0.0</AssemblyVersion>
<AssemblyVersion>7.17.1.0</AssemblyVersion>
<AssemblyVersion>7.17.2.0</AssemblyVersion>
<AssemblyVersion>7.17.3.0</AssemblyVersion>
<AssemblyVersion>7.17.4.0</AssemblyVersion>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The <see cref="T:Azure.Messaging.ServiceBus.ProcessSessionEventArgs" /> contain event args related to the session being processed.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProcessSessionEventArgs (Azure.Messaging.ServiceBus.ServiceBusSessionReceiver receiver, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.ServiceBus.ServiceBusSessionReceiver receiver, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.#ctor(Azure.Messaging.ServiceBus.ServiceBusSessionReceiver,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (receiver As ServiceBusSessionReceiver, cancellationToken As CancellationToken)" />
<MemberSignature Language="F#" Value="new Azure.Messaging.ServiceBus.ProcessSessionEventArgs : Azure.Messaging.ServiceBus.ServiceBusSessionReceiver * System.Threading.CancellationToken -> Azure.Messaging.ServiceBus.ProcessSessionEventArgs" Usage="new Azure.Messaging.ServiceBus.ProcessSessionEventArgs (receiver, cancellationToken)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="receiver" Type="Azure.Messaging.ServiceBus.ServiceBusSessionReceiver" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="receiver">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusSessionReceiver" /> that will be used for all settlement methods
for the args.</param>
<param name="cancellationToken">The processor's <see cref="T:System.Threading.CancellationToken" /> instance which will be cancelled in the event that <see cref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.StopProcessingAsync(System.Threading.CancellationToken)" /> is called.
</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Messaging.ServiceBus.ProcessSessionEventArgs" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProcessSessionEventArgs (Azure.Messaging.ServiceBus.ServiceBusSessionReceiver receiver, string identifier, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.ServiceBus.ServiceBusSessionReceiver receiver, string identifier, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.#ctor(Azure.Messaging.ServiceBus.ServiceBusSessionReceiver,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (receiver As ServiceBusSessionReceiver, identifier As String, cancellationToken As CancellationToken)" />
<MemberSignature Language="F#" Value="new Azure.Messaging.ServiceBus.ProcessSessionEventArgs : Azure.Messaging.ServiceBus.ServiceBusSessionReceiver * string * System.Threading.CancellationToken -> Azure.Messaging.ServiceBus.ProcessSessionEventArgs" Usage="new Azure.Messaging.ServiceBus.ProcessSessionEventArgs (receiver, identifier, cancellationToken)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="receiver" Type="Azure.Messaging.ServiceBus.ServiceBusSessionReceiver" />
<Parameter Name="identifier" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="receiver">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusSessionReceiver" /> that will be used for all settlement methods
for the args.</param>
<param name="identifier">The identifier of the processor.</param>
<param name="cancellationToken">The processor's <see cref="T:System.Threading.CancellationToken" /> instance which will be cancelled in the event that <see cref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.StopProcessingAsync(System.Threading.CancellationToken)" /> is called.
</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Messaging.ServiceBus.ProcessSessionEventArgs" /> class.
</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.ServiceBus.ProcessSessionEventArgs.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.ServiceBus.ProcessSessionEventArgs.CancellationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<summary>
A <see cref="T:System.Threading.CancellationToken" /> instance which will be
cancelled when <see cref="M:Azure.Messaging.ServiceBus.ServiceBusSessionProcessor.StopProcessingAsync(System.Threading.CancellationToken)" />
is called, or when the session lock has been lost.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EntityPath">
<MemberSignature Language="C#" Value="public string EntityPath { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EntityPath" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.EntityPath" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EntityPath As String" />
<MemberSignature Language="F#" Value="member this.EntityPath : string" Usage="Azure.Messaging.ServiceBus.ProcessSessionEventArgs.EntityPath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The path of the Service Bus entity that the message was received from.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FullyQualifiedNamespace">
<MemberSignature Language="C#" Value="public string FullyQualifiedNamespace { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FullyQualifiedNamespace" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.FullyQualifiedNamespace" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FullyQualifiedNamespace As String" />
<MemberSignature Language="F#" Value="member this.FullyQualifiedNamespace : string" Usage="Azure.Messaging.ServiceBus.ProcessSessionEventArgs.FullyQualifiedNamespace" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The fully qualified Service Bus namespace that the message was received from.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSessionStateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<BinaryData> GetSessionStateAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.BinaryData> GetSessionStateAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.GetSessionStateAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSessionStateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetSessionStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<BinaryData>
override this.GetSessionStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<BinaryData>" Usage="processSessionEventArgs.GetSessionStateAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">An optional <see cref="P:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Gets the session state.
</summary>
<returns>The session state as <see cref="T:System.BinaryData" />.</returns>
<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:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.Identifier" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Identifier As String" />
<MemberSignature Language="F#" Value="member this.Identifier : string" Usage="Azure.Messaging.ServiceBus.ProcessSessionEventArgs.Identifier" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The identifier of the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusSessionProcessor" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReleaseSession">
<MemberSignature Language="C#" Value="public virtual void ReleaseSession ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void ReleaseSession() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.ReleaseSession" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub ReleaseSession ()" />
<MemberSignature Language="F#" Value="abstract member ReleaseSession : unit -> unit
override this.ReleaseSession : unit -> unit" Usage="processSessionEventArgs.ReleaseSession " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Releases the session that is being processed. No receives will be initiated for the session and the
session will be closed.
The session may end up being reopened for processing immediately after closing if there are messages remaining in the session (
This depends on what other session messages may be in the queue or subscription).
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RenewSessionLockAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task RenewSessionLockAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task RenewSessionLockAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.RenewSessionLockAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function RenewSessionLockAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member RenewSessionLockAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RenewSessionLockAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="processSessionEventArgs.RenewSessionLockAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.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>
Renews the lock on the session specified by the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusSessionReceiver.SessionId" />. The lock will be renewed based on the setting specified on the entity.
</summary>
<returns>To be added.</returns>
<remarks>
<para>
When you accept a session, the session is locked for this receiver by the service for a duration as specified during the Queue/Subscription creation.
If processing of the session requires longer than this duration, the session-lock needs to be renewed.
For each renewal, it resets the time the session is locked by the LockDuration set on the Entity.
</para>
<para>
Renewal of session renews all the messages in the session as well. Each individual message need not be renewed.
</para>
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
The lock for the session has expired.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</exception>
</Docs>
</Member>
<Member MemberName="SessionId">
<MemberSignature Language="C#" Value="public string SessionId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SessionId" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.SessionId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SessionId As String" />
<MemberSignature Language="F#" Value="member this.SessionId : string" Usage="Azure.Messaging.ServiceBus.ProcessSessionEventArgs.SessionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The Session Id associated with the session being processed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SessionLockedUntil">
<MemberSignature Language="C#" Value="public DateTimeOffset SessionLockedUntil { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset SessionLockedUntil" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.SessionLockedUntil" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SessionLockedUntil As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.SessionLockedUntil : DateTimeOffset" Usage="Azure.Messaging.ServiceBus.ProcessSessionEventArgs.SessionLockedUntil" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:System.DateTimeOffset" /> that the current session is locked until.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetSessionStateAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task SetSessionStateAsync (BinaryData sessionState, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SetSessionStateAsync(class System.BinaryData sessionState, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.SetSessionStateAsync(System.BinaryData,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SetSessionStateAsync (sessionState As BinaryData, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SetSessionStateAsync : BinaryData * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.SetSessionStateAsync : BinaryData * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="processSessionEventArgs.SetSessionStateAsync (sessionState, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sessionState" Type="System.BinaryData" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="sessionState">A <see cref="T:System.BinaryData" /> of session state</param>
<param name="cancellationToken">An optional <see cref="P:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Set a custom state on the session which can be later retrieved using <see cref="M:Azure.Messaging.ServiceBus.ProcessSessionEventArgs.GetSessionStateAsync(System.Threading.CancellationToken)" /></summary>
<returns>A task to be resolved on when the operation has completed.</returns>
<remarks>This state is stored on Service Bus forever unless you set an empty state on it.</remarks>
</Docs>
</Member>
</Members>
</Type>