-
Notifications
You must be signed in to change notification settings - Fork 256
/
SessionHandlerOptions.xml
163 lines (163 loc) · 12.3 KB
/
SessionHandlerOptions.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
<Type Name="SessionHandlerOptions" FullName="Microsoft.Azure.ServiceBus.SessionHandlerOptions">
<TypeSignature Language="C#" Value="public sealed class SessionHandlerOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SessionHandlerOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.SessionHandlerOptions" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SessionHandlerOptions" />
<TypeSignature Language="F#" Value="type SessionHandlerOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.1.3.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides options associated with session pump processing using
<see cref="M:Microsoft.Azure.ServiceBus.QueueClient.RegisterSessionHandler(System.Func{Microsoft.Azure.ServiceBus.IMessageSession,Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task},Microsoft.Azure.ServiceBus.SessionHandlerOptions)" /> and
<see cref="M:Microsoft.Azure.ServiceBus.SubscriptionClient.RegisterSessionHandler(System.Func{Microsoft.Azure.ServiceBus.IMessageSession,Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task},Microsoft.Azure.ServiceBus.SessionHandlerOptions)" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SessionHandlerOptions (Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task> exceptionReceivedHandler);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`2<class Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs, class System.Threading.Tasks.Task> exceptionReceivedHandler) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.SessionHandlerOptions.#ctor(System.Func{Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (exceptionReceivedHandler As Func(Of ExceptionReceivedEventArgs, Task))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.SessionHandlerOptions : Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs, System.Threading.Tasks.Task> -> Microsoft.Azure.ServiceBus.SessionHandlerOptions" Usage="new Microsoft.Azure.ServiceBus.SessionHandlerOptions exceptionReceivedHandler" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="exceptionReceivedHandler" Type="System.Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task>" />
</Parameters>
<Docs>
<param name="exceptionReceivedHandler">A <see cref="T:System.Func`2" /> that is invoked during exceptions.
<see cref="T:Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs" /> contains contextual information regarding the exception.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Azure.ServiceBus.SessionHandlerOptions" /> class.
Default Values:
<see cref="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxConcurrentSessions" /> = 2000
<see cref="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.AutoComplete" /> = true
<see cref="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MessageWaitTimeout" /> = 1 minute
<see cref="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxAutoRenewDuration" /> = 5 minutes
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoComplete">
<MemberSignature Language="C#" Value="public bool AutoComplete { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AutoComplete" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.AutoComplete" />
<MemberSignature Language="VB.NET" Value="Public Property AutoComplete As Boolean" />
<MemberSignature Language="F#" Value="member this.AutoComplete : bool with get, set" Usage="Microsoft.Azure.ServiceBus.SessionHandlerOptions.AutoComplete" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets whether the autocomplete option for messages in the session handler is enabled.
If this value is true, if the handler returns without any failure, then the message is completed and will not show up in the session; if any
exception is thrown from the handler, the message is abandoned and the DeliveryCount of this message will increase by one.
If this value is false, if the handler returns without any failure, then user has to write the logic to explicitly complete the message,
otherwise the message is not considered 'completed' and will reappear in the session. </summary>
<value>true if the autocomplete option of the session handler is enabled; otherwise, false. Default is ture. </value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExceptionReceivedHandler">
<MemberSignature Language="C#" Value="public Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task> ExceptionReceivedHandler { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs, class System.Threading.Tasks.Task> ExceptionReceivedHandler" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.ExceptionReceivedHandler" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExceptionReceivedHandler As Func(Of ExceptionReceivedEventArgs, Task)" />
<MemberSignature Language="F#" Value="member this.ExceptionReceivedHandler : Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs, System.Threading.Tasks.Task>" Usage="Microsoft.Azure.ServiceBus.SessionHandlerOptions.ExceptionReceivedHandler" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when an exception is received. Enables you to be notified of any errors encountered by the session pump.
When errors are received calls will automatically be retried, so this is informational. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxAutoRenewDuration">
<MemberSignature Language="C#" Value="public TimeSpan MaxAutoRenewDuration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxAutoRenewDuration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxAutoRenewDuration" />
<MemberSignature Language="VB.NET" Value="Public Property MaxAutoRenewDuration As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxAutoRenewDuration : TimeSpan with get, set" Usage="Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxAutoRenewDuration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the duration for which the session lock will be renewed automatically. If a session lock is going to expire,
this value is the max duration for the session lock to be automatically renewed. </summary>
<value>The duration for which the session renew its state. Default is 5 min.</value>
<remarks>If this auto renewal fails, clients will receive an exception in the ExceptionReceivedHandler. </remarks>
</Docs>
</Member>
<Member MemberName="MaxConcurrentSessions">
<MemberSignature Language="C#" Value="public int MaxConcurrentSessions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxConcurrentSessions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxConcurrentSessions" />
<MemberSignature Language="VB.NET" Value="Public Property MaxConcurrentSessions As Integer" />
<MemberSignature Language="F#" Value="member this.MaxConcurrentSessions : int with get, set" Usage="Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxConcurrentSessions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum number of existing sessions that the User wants to handle concurrently. Setting this value to be
greater than the max number of active sessions in the service will not increase message throughput. </summary>
<value>The maximum number of sessions that the User wants to handle concurrently. Default is 2000.</value>
<remarks>The session-pump (SDK) will accept MaxConcurrentSessions number of sessions in parallel and dispatch the messages. The messages
within a session are delivered sequentially. If more than <see cref="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MaxConcurrentSessions" /> number of sessions are present in the
entity, they will be accepted one-by-one after closing the existing sessions.</remarks>
</Docs>
</Member>
<Member MemberName="MessageWaitTimeout">
<MemberSignature Language="C#" Value="public TimeSpan MessageWaitTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MessageWaitTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.SessionHandlerOptions.MessageWaitTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property MessageWaitTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MessageWaitTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.ServiceBus.SessionHandlerOptions.MessageWaitTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the timeout to wait for receiving a message. This is the time the session-pump waits before closing down the current
session and switching to a different session. </summary>
<value>The time to wait for receiving the message. Default is 1 min.</value>
<remarks>This value has an impact on the message throughput. If the value is very large, then every time the SDK waits for this duration
before closing to make sure that all the messages have been received. If users are having a lot of sessions and fewer messages per session,
try setting this to be a relative smaller value based on how frequent new messages arrive in the session. </remarks>
</Docs>
</Member>
</Members>
</Type>