-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
HostingAbstractionsHostExtensions.xml
215 lines (215 loc) · 15.4 KB
/
HostingAbstractionsHostExtensions.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
<Type Name="HostingAbstractionsHostExtensions" FullName="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions">
<TypeSignature Language="C#" Value="public static class HostingAbstractionsHostExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit HostingAbstractionsHostExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module HostingAbstractionsHostExtensions" />
<TypeSignature Language="F#" Value="type HostingAbstractionsHostExtensions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class HostingAbstractionsHostExtensions abstract sealed" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides extension methods for the <see cref="T:Microsoft.Extensions.Hosting.IHost" /> from the hosting abstractions package.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Run">
<MemberSignature Language="C#" Value="public static void Run (this Microsoft.Extensions.Hosting.IHost host);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Run(class Microsoft.Extensions.Hosting.IHost host) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(Microsoft.Extensions.Hosting.IHost)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub Run (host As IHost)" />
<MemberSignature Language="F#" Value="static member Run : Microsoft.Extensions.Hosting.IHost -> unit" Usage="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run host" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static void Run(Microsoft::Extensions::Hosting::IHost ^ host);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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.Extensions.Hosting.IHost" RefType="this" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost" /> to run.</param>
<summary>
Runs an application and block the calling thread until host shutdown.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RunAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task RunAsync (this Microsoft.Extensions.Hosting.IHost host, System.Threading.CancellationToken token = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task RunAsync(class Microsoft.Extensions.Hosting.IHost host, valuetype System.Threading.CancellationToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(Microsoft.Extensions.Hosting.IHost,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function RunAsync (host As IHost, Optional token As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member RunAsync : Microsoft.Extensions.Hosting.IHost * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync (host, token)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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.Extensions.Hosting.IHost" RefType="this" />
<Parameter Name="token" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost" /> to run.</param>
<param name="token">The token to trigger shutdown.</param>
<summary>
Runs an application and returns a <see cref="T:System.Threading.Tasks.Task" /> that only completes when the token is triggered or shutdown is triggered.
The <paramref name="host" /> instance is disposed of after running.
</summary>
<returns>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(Microsoft.Extensions.Hosting.IHost)" />.</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public static void Start (this Microsoft.Extensions.Hosting.IHost host);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Start(class Microsoft.Extensions.Hosting.IHost host) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Start(Microsoft.Extensions.Hosting.IHost)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub Start (host As IHost)" />
<MemberSignature Language="F#" Value="static member Start : Microsoft.Extensions.Hosting.IHost -> unit" Usage="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Start host" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static void Start(Microsoft::Extensions::Hosting::IHost ^ host);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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.Extensions.Hosting.IHost" RefType="this" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost" /> to start.</param>
<summary>
Starts the host synchronously.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StopAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task StopAsync (this Microsoft.Extensions.Hosting.IHost host, TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task StopAsync(class Microsoft.Extensions.Hosting.IHost host, valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.StopAsync(Microsoft.Extensions.Hosting.IHost,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function StopAsync (host As IHost, timeout As TimeSpan) As Task" />
<MemberSignature Language="F#" Value="static member StopAsync : Microsoft.Extensions.Hosting.IHost * TimeSpan -> System.Threading.Tasks.Task" Usage="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.StopAsync (host, timeout)" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ StopAsync(Microsoft::Extensions::Hosting::IHost ^ host, TimeSpan timeout);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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.Extensions.Hosting.IHost" RefType="this" />
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost" /> to stop.</param>
<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>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WaitForShutdown">
<MemberSignature Language="C#" Value="public static void WaitForShutdown (this Microsoft.Extensions.Hosting.IHost host);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void WaitForShutdown(class Microsoft.Extensions.Hosting.IHost host) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdown(Microsoft.Extensions.Hosting.IHost)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub WaitForShutdown (host As IHost)" />
<MemberSignature Language="F#" Value="static member WaitForShutdown : Microsoft.Extensions.Hosting.IHost -> unit" Usage="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdown host" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static void WaitForShutdown(Microsoft::Extensions::Hosting::IHost ^ host);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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.Extensions.Hosting.IHost" RefType="this" />
</Parameters>
<Docs>
<param name="host">The running <see cref="T:Microsoft.Extensions.Hosting.IHost" />.</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.Extensions.Hosting.IHost host, System.Threading.CancellationToken token = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task WaitForShutdownAsync(class Microsoft.Extensions.Hosting.IHost host, valuetype System.Threading.CancellationToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdownAsync(Microsoft.Extensions.Hosting.IHost,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WaitForShutdownAsync (host As IHost, Optional token As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member WaitForShutdownAsync : Microsoft.Extensions.Hosting.IHost * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdownAsync (host, token)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<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.Extensions.Hosting.IHost" RefType="this" />
<Parameter Name="token" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="host">The running <see cref="T:Microsoft.Extensions.Hosting.IHost" />.</param>
<param name="token">The token to trigger shutdown.</param>
<summary>
Returns a Task that completes when shutdown is triggered via the given token.
</summary>
<returns>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdown(Microsoft.Extensions.Hosting.IHost)" />.</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
</Members>
</Type>