-
Notifications
You must be signed in to change notification settings - Fork 112
/
WebHostExtensions.xml
271 lines (271 loc) · 18.3 KB
/
WebHostExtensions.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
<Type Name="WebHostExtensions" FullName="Microsoft.AspNetCore.Hosting.WebHostExtensions">
<TypeSignature Language="C++ CLI" Value="public ref class WebHostExtensions abstract sealed" />
<TypeSignature Language="C#" Value="public static class WebHostExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit WebHostExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Hosting.WebHostExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module WebHostExtensions" />
<TypeSignature Language="F#" Value="type WebHostExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Contains extensions for managing the lifecycle of an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Run">
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static void Run(Microsoft::AspNetCore::Hosting::IWebHost ^ host);" />
<MemberSignature Language="C#" Value="public static void Run (this Microsoft.AspNetCore.Hosting.IWebHost host);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Run(class Microsoft.AspNetCore.Hosting.IWebHost host) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.Run(Microsoft.AspNetCore.Hosting.IWebHost)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub Run (host As IWebHost)" />
<MemberSignature Language="F#" Value="static member Run : Microsoft.AspNetCore.Hosting.IWebHost -> unit" Usage="Microsoft.AspNetCore.Hosting.WebHostExtensions.Run host" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="host" Type="Microsoft.AspNetCore.Hosting.IWebHost" RefType="this" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" /> to run.</param>
<summary>
Runs a web application and block the calling thread until host shutdown.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Run">
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static void Run(Microsoft::AspNetCore::Hosting::IWebHost ^ host, System::Threading::CancellationToken token);" />
<MemberSignature Language="C#" Value="public static void Run (this Microsoft.AspNetCore.Hosting.IWebHost host, System.Threading.CancellationToken token);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Run(class Microsoft.AspNetCore.Hosting.IWebHost host, valuetype System.Threading.CancellationToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.Run(Microsoft.AspNetCore.Hosting.IWebHost,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub Run (host As IWebHost, token As CancellationToken)" />
<MemberSignature Language="F#" Value="static member Run : Microsoft.AspNetCore.Hosting.IWebHost * System.Threading.CancellationToken -> unit" Usage="Microsoft.AspNetCore.Hosting.WebHostExtensions.Run (host, token)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="host" Type="Microsoft.AspNetCore.Hosting.IWebHost" RefType="this" Index="0" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1" />
<Parameter Name="token" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" /> to run.</param>
<param name="token">The token to trigger shutdown.</param>
<summary>
Runs a web application and block the calling thread until token is triggered or shutdown is triggered.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RunAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task RunAsync (this Microsoft.AspNetCore.Hosting.IWebHost host, System.Threading.CancellationToken token = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task RunAsync(class Microsoft.AspNetCore.Hosting.IWebHost host, valuetype System.Threading.CancellationToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.RunAsync(Microsoft.AspNetCore.Hosting.IWebHost,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function RunAsync (host As IWebHost, Optional token As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member RunAsync : Microsoft.AspNetCore.Hosting.IWebHost * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.AspNetCore.Hosting.WebHostExtensions.RunAsync (host, token)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-3.0;aspnetcore-3.1">
<AttributeName Language="C#">[System.Diagnostics.DebuggerStepThrough]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerStepThrough>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="host" Type="Microsoft.AspNetCore.Hosting.IWebHost" RefType="this" Index="0" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="token" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" /> to run.</param>
<param name="token">The token to trigger shutdown.</param>
<summary>
Runs a web application and returns a Task that only completes when the token is triggered or shutdown is triggered.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StopAsync">
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ StopAsync(Microsoft::AspNetCore::Hosting::IWebHost ^ host, TimeSpan timeout);" />
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task StopAsync (this Microsoft.AspNetCore.Hosting.IWebHost host, TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task StopAsync(class Microsoft.AspNetCore.Hosting.IWebHost host, valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.StopAsync(Microsoft.AspNetCore.Hosting.IWebHost,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function StopAsync (host As IWebHost, timeout As TimeSpan) As Task" />
<MemberSignature Language="F#" Value="static member StopAsync : Microsoft.AspNetCore.Hosting.IWebHost * TimeSpan -> System.Threading.Tasks.Task" Usage="Microsoft.AspNetCore.Hosting.WebHostExtensions.StopAsync (host, timeout)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="host" Type="Microsoft.AspNetCore.Hosting.IWebHost" RefType="this" Index="0" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="timeout" Type="System.TimeSpan" Index="1" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
</Parameters>
<Docs>
<param name="host" />
<param name="timeout">The timeout for stopping gracefully. Once expired the
server may terminate any remaining active connections.</param>
<summary>
Attempts to gracefully stop the host with the given timeout.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that completes when the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" /> stops.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WaitForShutdown">
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static void WaitForShutdown(Microsoft::AspNetCore::Hosting::IWebHost ^ host);" />
<MemberSignature Language="C#" Value="public static void WaitForShutdown (this Microsoft.AspNetCore.Hosting.IWebHost host);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void WaitForShutdown(class Microsoft.AspNetCore.Hosting.IWebHost host) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.WaitForShutdown(Microsoft.AspNetCore.Hosting.IWebHost)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub WaitForShutdown (host As IWebHost)" />
<MemberSignature Language="F#" Value="static member WaitForShutdown : Microsoft.AspNetCore.Hosting.IWebHost -> unit" Usage="Microsoft.AspNetCore.Hosting.WebHostExtensions.WaitForShutdown host" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="host" Type="Microsoft.AspNetCore.Hosting.IWebHost" RefType="this" Index="0" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
</Parameters>
<Docs>
<param name="host">The running <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.</param>
<summary>
Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WaitForShutdownAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task WaitForShutdownAsync (this Microsoft.AspNetCore.Hosting.IWebHost host, System.Threading.CancellationToken token = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task WaitForShutdownAsync(class Microsoft.AspNetCore.Hosting.IWebHost host, valuetype System.Threading.CancellationToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.WaitForShutdownAsync(Microsoft.AspNetCore.Hosting.IWebHost,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WaitForShutdownAsync (host As IWebHost, Optional token As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member WaitForShutdownAsync : Microsoft.AspNetCore.Hosting.IWebHost * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.AspNetCore.Hosting.WebHostExtensions.WaitForShutdownAsync (host, token)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Hosting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-3.0;aspnetcore-3.1">
<AttributeName Language="C#">[System.Diagnostics.DebuggerStepThrough]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerStepThrough>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="host" Type="Microsoft.AspNetCore.Hosting.IWebHost" RefType="this" Index="0" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="token" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
</Parameters>
<Docs>
<param name="host">The running <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.</param>
<param name="token">The token to trigger shutdown.</param>
<summary>
Returns a Task that completes when shutdown is triggered via the given token, Ctrl+C or SIGTERM.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that completes when shutdown is triggered via Ctrl+C or SIGTERM.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>