-
Notifications
You must be signed in to change notification settings - Fork 255
/
ServiceBusSessionReceiverOptions.xml
239 lines (239 loc) · 12.7 KB
/
ServiceBusSessionReceiverOptions.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
<Type Name="ServiceBusSessionReceiverOptions" FullName="Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions">
<TypeSignature Language="C#" Value="public class ServiceBusSessionReceiverOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusSessionReceiverOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusSessionReceiverOptions" />
<TypeSignature Language="F#" Value="type ServiceBusSessionReceiverOptions = class" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The set of options that can be specified when creating a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusSessionReceiver" />
to configure its behavior.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusSessionReceiverOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="serviceBusSessionReceiverOptions.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.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>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
<summary>
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
</summary>
<returns>
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="serviceBusSessionReceiverOptions.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.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>
<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>
<Member MemberName="Identifier">
<MemberSignature Language="C#" Value="public string Identifier { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Identifier" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.Identifier" />
<MemberSignature Language="VB.NET" Value="Public Property Identifier As String" />
<MemberSignature Language="F#" Value="member this.Identifier : string with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.Identifier" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A property used to set the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> ID to identify the client. This can be used to correlate logs
and exceptions. If <c>null</c> or empty, a random unique value will be used.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrefetchCount">
<MemberSignature Language="C#" Value="public int PrefetchCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.PrefetchCount" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" />
<MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.PrefetchCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the number of messages that will be eagerly requested from Queues or Subscriptions and queued locally without regard to
whether the receiver is actively receiving, intended to help maximize throughput by allowing the receiver to receive
from a local cache rather than waiting on a service request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
A negative value is attempted to be set for the property.
</exception>
</Docs>
</Member>
<Member MemberName="ReceiveMode">
<MemberSignature Language="C#" Value="public Azure.Messaging.ServiceBus.ServiceBusReceiveMode ReceiveMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Messaging.ServiceBus.ServiceBusReceiveMode ReceiveMode" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.ReceiveMode" />
<MemberSignature Language="VB.NET" Value="Public Property ReceiveMode As ServiceBusReceiveMode" />
<MemberSignature Language="F#" Value="member this.ReceiveMode : Azure.Messaging.ServiceBus.ServiceBusReceiveMode with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.ReceiveMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.ServiceBus.ServiceBusReceiveMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.ReceiveMode" /> used to specify how messages are received. Defaults to PeekLock mode.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="serviceBusSessionReceiverOptions.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
<AssemblyVersion>7.18.0.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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the instance to string representation.
</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>