- Notifications
You must be signed in to change notification settings - Fork 280
/
Copy pathServiceBusProcessor.xml
799 lines (799 loc) · 50.2 KB
/
ServiceBusProcessor.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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
<TypeName="ServiceBusProcessor"FullName="Azure.Messaging.ServiceBus.ServiceBusProcessor">
<TypeSignatureLanguage="C#"Value="public class ServiceBusProcessor : IAsyncDisposable" />
<TypeSignatureLanguage="ILAsm"Value=".class public auto ansi beforefieldinit ServiceBusProcessor extends System.Object implements class System.IAsyncDisposable" />
<TypeSignatureLanguage="DocId"Value="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" />
<TypeSignatureLanguage="VB.NET"Value="Public Class ServiceBusProcessor
Implements IAsyncDisposable" />
<TypeSignatureLanguage="F#"Value="type ServiceBusProcessor = class
 interface IAsyncDisposable" />
<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>
<AssemblyVersion>7.18.2.0</AssemblyVersion>
<AssemblyVersion>7.18.3.0</AssemblyVersion>
<AssemblyVersion>7.18.4.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IAsyncDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
The <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" /> provides an abstraction around a set of <seecref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" />
that allows using an event based model for processing received <seecref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />.
It is constructed by calling <seecref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateProcessor(System.String,Azure.Messaging.ServiceBus.ServiceBusProcessorOptions)" />.
The message handler is specified with the <seecref="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessMessageAsync" />
property. The error handler is specified with the <seecref="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessErrorAsync" /> property.
To start processing after the handlers have been specified, call <seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.StartProcessingAsync(System.Threading.CancellationToken)" />.
</summary>
<remarks>
The <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" /> is safe to cache and use for the lifetime of an application
or until the <seecref="T:Azure.Messaging.ServiceBus.ServiceBusClient" /> that it was created by is disposed. Caching the processor
is recommended when the application is processing messages regularly. The sender is responsible for
ensuring efficient network, CPU, and memory use. Calling <seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.DisposeAsync" /> on the
associated <seecref="T:Azure.Messaging.ServiceBus.ServiceBusClient" /> as the application is shutting down will ensure that
network resources and other unmanaged objects used by the processor are properly cleaned up.
</remarks>
</Docs>
<Members>
<MemberMemberName=".ctor">
<MemberSignatureLanguage="C#"Value="protected ServiceBusProcessor ();" />
<MemberSignatureLanguage="ILAsm"Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.#ctor" />
<MemberSignatureLanguage="VB.NET"Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" /> class for mocking.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName=".ctor">
<MemberSignatureLanguage="C#"Value="protected ServiceBusProcessor (Azure.Messaging.ServiceBus.ServiceBusClient client, string queueName, Azure.Messaging.ServiceBus.ServiceBusProcessorOptions options);" />
<MemberSignatureLanguage="ILAsm"Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.ServiceBus.ServiceBusClient client, string queueName, class Azure.Messaging.ServiceBus.ServiceBusProcessorOptions options) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.#ctor(Azure.Messaging.ServiceBus.ServiceBusClient,System.String,Azure.Messaging.ServiceBus.ServiceBusProcessorOptions)" />
<MemberSignatureLanguage="VB.NET"Value="Protected Sub New (client As ServiceBusClient, queueName As String, options As ServiceBusProcessorOptions)" />
<MemberSignatureLanguage="F#"Value="new Azure.Messaging.ServiceBus.ServiceBusProcessor : Azure.Messaging.ServiceBus.ServiceBusClient * string * Azure.Messaging.ServiceBus.ServiceBusProcessorOptions -> Azure.Messaging.ServiceBus.ServiceBusProcessor"Usage="new Azure.Messaging.ServiceBus.ServiceBusProcessor (client, queueName, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<ParameterName="client"Type="Azure.Messaging.ServiceBus.ServiceBusClient" />
<ParameterName="queueName"Type="System.String" />
<ParameterName="options"Type="Azure.Messaging.ServiceBus.ServiceBusProcessorOptions" />
</Parameters>
<Docs>
<paramname="client">The client instance to use for the processor.</param>
<paramname="queueName">The name of the queue to processor from.</param>
<paramname="options">The set of options to use when configuring the processor.</param>
<summary>
Initializes a new instance of the <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" /> class for use with derived types.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName=".ctor">
<MemberSignatureLanguage="C#"Value="protected ServiceBusProcessor (Azure.Messaging.ServiceBus.ServiceBusClient client, string topicName, string subscriptionName, Azure.Messaging.ServiceBus.ServiceBusProcessorOptions options);" />
<MemberSignatureLanguage="ILAsm"Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.ServiceBus.ServiceBusClient client, string topicName, string subscriptionName, class Azure.Messaging.ServiceBus.ServiceBusProcessorOptions options) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.#ctor(Azure.Messaging.ServiceBus.ServiceBusClient,System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusProcessorOptions)" />
<MemberSignatureLanguage="VB.NET"Value="Protected Sub New (client As ServiceBusClient, topicName As String, subscriptionName As String, options As ServiceBusProcessorOptions)" />
<MemberSignatureLanguage="F#"Value="new Azure.Messaging.ServiceBus.ServiceBusProcessor : Azure.Messaging.ServiceBus.ServiceBusClient * string * string * Azure.Messaging.ServiceBus.ServiceBusProcessorOptions -> Azure.Messaging.ServiceBus.ServiceBusProcessor"Usage="new Azure.Messaging.ServiceBus.ServiceBusProcessor (client, topicName, subscriptionName, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<ParameterName="client"Type="Azure.Messaging.ServiceBus.ServiceBusClient" />
<ParameterName="topicName"Type="System.String" />
<ParameterName="subscriptionName"Type="System.String" />
<ParameterName="options"Type="Azure.Messaging.ServiceBus.ServiceBusProcessorOptions" />
</Parameters>
<Docs>
<paramname="client">The client instance to use for the processor.</param>
<paramname="topicName">The topic to create a processor for.</param>
<paramname="subscriptionName">The subscription to create a processor for.</param>
<paramname="options">The set of options to use when configuring the processor.</param>
<summary>
Initializes a new instance of the <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" /> class for use with derived types.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="AutoCompleteMessages">
<MemberSignatureLanguage="C#"Value="public virtual bool AutoCompleteMessages { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance bool AutoCompleteMessages" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.AutoCompleteMessages" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property AutoCompleteMessages As Boolean" />
<MemberSignatureLanguage="F#"Value="member this.AutoCompleteMessages : bool"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.AutoCompleteMessages" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a value that indicates whether the processor should automatically
complete messages after the message handler has completed processing. If the
message handler triggers an exception, the message will not be automatically
completed.
</summary>
<value>
The option to auto complete messages is specified using <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessorOptions.AutoCompleteMessages" />
and has a default value of <c>true</c>.
</value>
<remarks>
If the message handler triggers an exception and did not settle the message,
then the message will be automatically abandoned, irrespective of <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.AutoCompleteMessages" />.
</remarks>
</Docs>
</Member>
<MemberMemberName="CloseAsync">
<MemberSignatureLanguage="C#"Value="public virtual System.Threading.Tasks.Task CloseAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.CloseAsync(System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable Function CloseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignatureLanguage="F#"Value="abstract member CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task"Usage="serviceBusProcessor.CloseAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<paramname="cancellationToken"> An optional<seecref="T:System.Threading.CancellationToken" /> instance to signal the
request to cancel the operation.</param>
<summary>
Performs the task needed to clean up resources used by the <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" />. Any in-flight message handlers will
be awaited. Once all message handling has completed, the underlying links will be closed. After this point, the method will return.
This is equivalent to calling <seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.DisposeAsync" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="DisposeAsync">
<MemberSignatureLanguage="C#"Value="public System.Threading.Tasks.ValueTask DisposeAsync ();" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask DisposeAsync() cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.DisposeAsync" />
<MemberSignatureLanguage="VB.NET"Value="Public Function DisposeAsync () As ValueTask" />
<MemberSignatureLanguage="F#"Value="abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask"Usage="serviceBusProcessor.DisposeAsync " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IAsyncDisposable.DisposeAsync</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Performs the task needed to clean up resources used by the <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" />. Any in-flight message handlers will
be awaited. Once all message handling has completed, the underlying links will be closed. After this point, the method will return.
This is equivalent to calling <seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.CloseAsync(System.Threading.CancellationToken)" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="EntityPath">
<MemberSignatureLanguage="C#"Value="public virtual string EntityPath { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance string EntityPath" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.EntityPath" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property EntityPath As String" />
<MemberSignatureLanguage="F#"Value="member this.EntityPath : string"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.EntityPath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the path of the Service Bus entity that the processor is connected to, specific to the
Service Bus namespace that contains it.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="Equals">
<MemberSignatureLanguage="C#"Value="public override bool Equals (object obj);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.Equals(System.Object)" />
<MemberSignatureLanguage="VB.NET"Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignatureLanguage="F#"Value="override this.Equals : obj -> bool"Usage="serviceBusProcessor.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeNameLanguage="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeNameLanguage="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="obj"Type="System.Object" />
</Parameters>
<Docs>
<paramname="obj">The <seecref="T:System.Object" /> to compare with this instance.</param>
<summary>
Determines whether the specified <seecref="T:System.Object" /> is equal to this instance.
</summary>
<returns>
<c>true</c> if the specified <seecref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="FullyQualifiedNamespace">
<MemberSignatureLanguage="C#"Value="public virtual string FullyQualifiedNamespace { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance string FullyQualifiedNamespace" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.FullyQualifiedNamespace" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property FullyQualifiedNamespace As String" />
<MemberSignatureLanguage="F#"Value="member this.FullyQualifiedNamespace : string"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.FullyQualifiedNamespace" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the fully qualified Service Bus namespace that the receiver is associated with. This is likely
to be similar to <c>{yournamespace}.servicebus.windows.net</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="GetHashCode">
<MemberSignatureLanguage="C#"Value="public override int GetHashCode ();" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.GetHashCode" />
<MemberSignatureLanguage="VB.NET"Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignatureLanguage="F#"Value="override this.GetHashCode : unit -> int"Usage="serviceBusProcessor.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeNameLanguage="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeNameLanguage="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a hash code for this instance.
</summary>
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="Identifier">
<MemberSignatureLanguage="C#"Value="public virtual string Identifier { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance string Identifier" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.Identifier" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property Identifier As String" />
<MemberSignatureLanguage="F#"Value="member this.Identifier : string"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.Identifier" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the ID used to identify this processor. This can be used to correlate logs and exceptions.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="IsClosed">
<MemberSignatureLanguage="C#"Value="public bool IsClosed { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance bool IsClosed" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.IsClosed" />
<MemberSignatureLanguage="VB.NET"Value="Public ReadOnly Property IsClosed As Boolean" />
<MemberSignatureLanguage="F#"Value="member this.IsClosed : bool"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.IsClosed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates whether or not this <seecref="T:Azure.Messaging.ServiceBus.ServiceBusProcessor" /> has been closed.
</summary>
<value>
<c>true</c> if the processor is closed; otherwise, <c>false</c>.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="IsProcessing">
<MemberSignatureLanguage="C#"Value="public virtual bool IsProcessing { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance bool IsProcessing" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.IsProcessing" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property IsProcessing As Boolean" />
<MemberSignatureLanguage="F#"Value="member this.IsProcessing : bool"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.IsProcessing" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets whether or not this processor is currently processing messages.
</summary>
<value>
<c>true</c> if the processor is processing messages; otherwise, <c>false</c>.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="MaxAutoLockRenewalDuration">
<MemberSignatureLanguage="C#"Value="public virtual TimeSpan MaxAutoLockRenewalDuration { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.TimeSpan MaxAutoLockRenewalDuration" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.MaxAutoLockRenewalDuration" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property MaxAutoLockRenewalDuration As TimeSpan" />
<MemberSignatureLanguage="F#"Value="member this.MaxAutoLockRenewalDuration : TimeSpan"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.MaxAutoLockRenewalDuration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the maximum duration within which the lock will be renewed automatically. This
value should be greater than the longest message lock duration; for example, the LockDuration Property.
</summary>
<value>
The maximum duration for lock renewal is specified using <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessorOptions.MaxAutoLockRenewalDuration" />
and has a default value of 5 minutes.
</value>
<remarks>The message renew can continue for sometime in the background
after completion of message and result in a few false MessageLockLostExceptions temporarily.</remarks>
</Docs>
</Member>
<MemberMemberName="MaxConcurrentCalls">
<MemberSignatureLanguage="C#"Value="public virtual int MaxConcurrentCalls { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance int32 MaxConcurrentCalls" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.MaxConcurrentCalls" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property MaxConcurrentCalls As Integer" />
<MemberSignatureLanguage="F#"Value="member this.MaxConcurrentCalls : int"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.MaxConcurrentCalls" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the maximum number of concurrent calls to the
<seecref="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessMessageAsync" /> message handler the processor should initiate.
</summary>
<value>
The number of maximum concurrent calls is specified using <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessorOptions.MaxConcurrentCalls" />
and has a default value of 1.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="OnProcessErrorAsync">
<MemberSignatureLanguage="C#"Value="protected internal virtual System.Threading.Tasks.Task OnProcessErrorAsync (Azure.Messaging.ServiceBus.ProcessErrorEventArgs args);" />
<MemberSignatureLanguage="ILAsm"Value=".method familyorassemblyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnProcessErrorAsync(class Azure.Messaging.ServiceBus.ProcessErrorEventArgs args) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.OnProcessErrorAsync(Azure.Messaging.ServiceBus.ProcessErrorEventArgs)" />
<MemberSignatureLanguage="VB.NET"Value="Protected Friend Overridable Function OnProcessErrorAsync (args As ProcessErrorEventArgs) As Task" />
<MemberSignatureLanguage="F#"Value="abstract member OnProcessErrorAsync : Azure.Messaging.ServiceBus.ProcessErrorEventArgs -> System.Threading.Tasks.Task
override this.OnProcessErrorAsync : Azure.Messaging.ServiceBus.ProcessErrorEventArgs -> System.Threading.Tasks.Task"Usage="serviceBusProcessor.OnProcessErrorAsync args" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="args"Type="Azure.Messaging.ServiceBus.ProcessErrorEventArgs" />
</Parameters>
<Docs>
<paramname="args">The event args containing information related to the error.</param>
<summary>
Invokes the error event handler when an error has occurred during processing.
This method can be overridden to raise an event manually for testing purposes.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="OnProcessMessageAsync">
<MemberSignatureLanguage="C#"Value="protected internal virtual System.Threading.Tasks.Task OnProcessMessageAsync (Azure.Messaging.ServiceBus.ProcessMessageEventArgs args);" />
<MemberSignatureLanguage="ILAsm"Value=".method familyorassemblyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnProcessMessageAsync(class Azure.Messaging.ServiceBus.ProcessMessageEventArgs args) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.OnProcessMessageAsync(Azure.Messaging.ServiceBus.ProcessMessageEventArgs)" />
<MemberSignatureLanguage="VB.NET"Value="Protected Friend Overridable Function OnProcessMessageAsync (args As ProcessMessageEventArgs) As Task" />
<MemberSignatureLanguage="F#"Value="abstract member OnProcessMessageAsync : Azure.Messaging.ServiceBus.ProcessMessageEventArgs -> System.Threading.Tasks.Task
override this.OnProcessMessageAsync : Azure.Messaging.ServiceBus.ProcessMessageEventArgs -> System.Threading.Tasks.Task"Usage="serviceBusProcessor.OnProcessMessageAsync args" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="args"Type="Azure.Messaging.ServiceBus.ProcessMessageEventArgs" />
</Parameters>
<Docs>
<paramname="args">The event args containing information related to the message.</param>
<summary>
Invokes the process message event handler after a message has been received.
This method can be overridden to raise an event manually for testing purposes.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="PrefetchCount">
<MemberSignatureLanguage="C#"Value="public virtual int PrefetchCount { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance int32 PrefetchCount" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.PrefetchCount" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property PrefetchCount As Integer" />
<MemberSignatureLanguage="F#"Value="member this.PrefetchCount : int"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.PrefetchCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the number of messages that will be eagerly requested from Queues or Subscriptions
during processing. This is intended to help maximize throughput by allowing the
processor to receive from a local cache rather than waiting on a service request.
</summary>
<value>
The prefetch count is specified using <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessorOptions.PrefetchCount" />
and has a default value of 0.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="ProcessErrorAsync">
<MemberSignatureLanguage="C#"Value="public event Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs,System.Threading.Tasks.Task> ProcessErrorAsync;" />
<MemberSignatureLanguage="ILAsm"Value=".event class System.Func`2<class Azure.Messaging.ServiceBus.ProcessErrorEventArgs, class System.Threading.Tasks.Task> ProcessErrorAsync" />
<MemberSignatureLanguage="DocId"Value="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessErrorAsync" />
<MemberSignatureLanguage="VB.NET"Value="Public Custom Event ProcessErrorAsync As Func(Of ProcessErrorEventArgs, Task) " />
<MemberSignatureLanguage="F#"Value="member this.ProcessErrorAsync : Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs, System.Threading.Tasks.Task>"Usage="member this.ProcessErrorAsync : System.Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs, System.Threading.Tasks.Task>" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
The handler responsible for processing unhandled exceptions thrown while
this processor is running.
Implementation is mandatory.
</summary>
<remarks>
It is not recommended that the state of the processor be managed directly from within this handler; requesting to start or stop the processor may result in
a deadlock scenario.
</remarks>
</Docs>
</Member>
<MemberMemberName="ProcessMessageAsync">
<MemberSignatureLanguage="C#"Value="public event Func<Azure.Messaging.ServiceBus.ProcessMessageEventArgs,System.Threading.Tasks.Task> ProcessMessageAsync;" />
<MemberSignatureLanguage="ILAsm"Value=".event class System.Func`2<class Azure.Messaging.ServiceBus.ProcessMessageEventArgs, class System.Threading.Tasks.Task> ProcessMessageAsync" />
<MemberSignatureLanguage="DocId"Value="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessMessageAsync" />
<MemberSignatureLanguage="VB.NET"Value="Public Custom Event ProcessMessageAsync As Func(Of ProcessMessageEventArgs, Task) " />
<MemberSignatureLanguage="F#"Value="member this.ProcessMessageAsync : Func<Azure.Messaging.ServiceBus.ProcessMessageEventArgs, System.Threading.Tasks.Task>"Usage="member this.ProcessMessageAsync : System.Func<Azure.Messaging.ServiceBus.ProcessMessageEventArgs, System.Threading.Tasks.Task>" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Azure.Messaging.ServiceBus.ProcessMessageEventArgs,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
The handler responsible for processing messages received from the Queue
or Subscription.
Implementation is mandatory.
</summary>
<remarks>
It is not recommended that the state of the processor be managed directly from within this handler; requesting to start or stop the processor may result in
a deadlock scenario.
</remarks>
</Docs>
</Member>
<MemberMemberName="ReceiveMode">
<MemberSignatureLanguage="C#"Value="public virtual Azure.Messaging.ServiceBus.ServiceBusReceiveMode ReceiveMode { get; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance valuetype Azure.Messaging.ServiceBus.ServiceBusReceiveMode ReceiveMode" />
<MemberSignatureLanguage="DocId"Value="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.ReceiveMode" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable ReadOnly Property ReceiveMode As ServiceBusReceiveMode" />
<MemberSignatureLanguage="F#"Value="member this.ReceiveMode : Azure.Messaging.ServiceBus.ServiceBusReceiveMode"Usage="Azure.Messaging.ServiceBus.ServiceBusProcessor.ReceiveMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.ServiceBus.ServiceBusReceiveMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.ReceiveMode" /> used to specify how messages are received. Defaults to PeekLock mode.
</summary>
<value>
The receive mode is specified using <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessorOptions.ReceiveMode" />
and has a default mode of <seecref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="StartProcessingAsync">
<MemberSignatureLanguage="C#"Value="public virtual System.Threading.Tasks.Task StartProcessingAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task StartProcessingAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.StartProcessingAsync(System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable Function StartProcessingAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignatureLanguage="F#"Value="abstract member StartProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.StartProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task"Usage="serviceBusProcessor.StartProcessingAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<paramname="cancellationToken">A <seecref="T:System.Threading.CancellationToken" /> instance to
signal the request to cancel the start operation. This won't affect the
processor once it starts running.
</param>
<summary>
Signals the processor to begin processing messages. Should this method be
called while the processor is already running, an
<seecref="T:System.InvalidOperationException" /> is thrown.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exceptioncref="T:System.InvalidOperationException">
This can occur if the processor is already running. This can be checked via the <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.IsProcessing" /> property.
This can also occur if event handlers have not been specified for the <seecref="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessMessageAsync" /> or
the <seecref="E:Azure.Messaging.ServiceBus.ServiceBusProcessor.ProcessErrorAsync" /> events.
</exception>
</Docs>
</Member>
<MemberMemberName="StopProcessingAsync">
<MemberSignatureLanguage="C#"Value="public virtual System.Threading.Tasks.Task StopProcessingAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task StopProcessingAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.StopProcessingAsync(System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="Public Overridable Function StopProcessingAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignatureLanguage="F#"Value="abstract member StopProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.StopProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task"Usage="serviceBusProcessor.StopProcessingAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<paramname="cancellationToken">A <seecref="T:System.Threading.CancellationToken" /> instance to
signal the request to cancel the stop operation. If the operation is successfully
canceled, the processor will keep running.</param>
<summary>
Signals the processor to stop processing messaging. Should this method be
called while the processor is not running, no action is taken. This method
will not close the underlying receivers, but will cause the receivers to stop
receiving. Any in-flight message handlers will be awaited, and this method will not return
until all in-flight message handlers have returned. To close the underlying receivers, <seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.CloseAsync(System.Threading.CancellationToken)" />
should be called. If <seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.CloseAsync(System.Threading.CancellationToken)" /> is called, the processor cannot be restarted.
If you wish to resume processing at some point after calling this method, you can call
<seecref="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.StartProcessingAsync(System.Threading.CancellationToken)" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="ToString">
<MemberSignatureLanguage="C#"Value="public override string ToString ();" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.ToString" />
<MemberSignatureLanguage="VB.NET"Value="Public Overrides Function ToString () As String" />
<MemberSignatureLanguage="F#"Value="override this.ToString : unit -> string"Usage="serviceBusProcessor.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeNameLanguage="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeNameLanguage="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the instance to string representation.
</summary>
<returns>A <seecref="T:System.String" /> that represents this instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="UpdateConcurrency">
<MemberSignatureLanguage="C#"Value="public void UpdateConcurrency (int maxConcurrentCalls);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig instance void UpdateConcurrency(int32 maxConcurrentCalls) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.UpdateConcurrency(System.Int32)" />
<MemberSignatureLanguage="VB.NET"Value="Public Sub UpdateConcurrency (maxConcurrentCalls As Integer)" />
<MemberSignatureLanguage="F#"Value="member this.UpdateConcurrency : int -> unit"Usage="serviceBusProcessor.UpdateConcurrency maxConcurrentCalls" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="maxConcurrentCalls"Type="System.Int32" />
</Parameters>
<Docs>
<paramname="maxConcurrentCalls">The new max concurrent calls value. This will be reflected in the <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.MaxConcurrentCalls" />
property.</param>
<summary>
Updates the concurrency for the processor. This method can be used to dynamically change the concurrency of a running processor.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="UpdatePrefetchCount">
<MemberSignatureLanguage="C#"Value="public void UpdatePrefetchCount (int prefetchCount);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig instance void UpdatePrefetchCount(int32 prefetchCount) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Azure.Messaging.ServiceBus.ServiceBusProcessor.UpdatePrefetchCount(System.Int32)" />
<MemberSignatureLanguage="VB.NET"Value="Public Sub UpdatePrefetchCount (prefetchCount As Integer)" />
<MemberSignatureLanguage="F#"Value="member this.UpdatePrefetchCount : int -> unit"Usage="serviceBusProcessor.UpdatePrefetchCount prefetchCount" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
<AssemblyVersion>7.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<ParameterName="prefetchCount"Type="System.Int32" />
</Parameters>
<Docs>
<paramname="prefetchCount">The new prefetch count value. This will be reflected in the <seecref="P:Azure.Messaging.ServiceBus.ServiceBusProcessor.PrefetchCount" />
property.</param>
<summary>
Updates the prefetch count for the processor. This method can be used to dynamically change the prefetch count of a running processor.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>