-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathIHost.xml
111 lines (111 loc) · 6.71 KB
/
IHost.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
<Type Name="IHost" FullName="Microsoft.Extensions.Hosting.IHost">
<TypeSignature Language="C#" Value="public interface IHost : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IHost implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Hosting.IHost" />
<TypeSignature Language="VB.NET" Value="Public Interface IHost
Implements IDisposable" />
<TypeSignature Language="F#" Value="type IHost = interface
 interface IDisposable" />
<TypeSignature Language="C++ CLI" Value="public interface class IHost : IDisposable" />
<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>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A program abstraction.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Services">
<MemberSignature Language="C#" Value="public IServiceProvider Services { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IServiceProvider Services" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Hosting.IHost.Services" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Services As IServiceProvider" />
<MemberSignature Language="F#" Value="member this.Services : IServiceProvider" Usage="Microsoft.Extensions.Hosting.IHost.Services" />
<MemberSignature Language="C++ CLI" Value="public:
 property IServiceProvider ^ Services { IServiceProvider ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IServiceProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the services configured for the program (for example, using <see cref="M:HostBuilder.ConfigureServices(Action<HostBuilderContext,IServiceCollection>)" />).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task StartAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task StartAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function StartAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member StartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iHost.StartAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">Used to abort program start.</param>
<summary>
Starts the <see cref="T:Microsoft.Extensions.Hosting.IHostedService" /> objects configured for the program.
The application will run until interrupted or until <see cref="M:IHostApplicationLifetime.StopApplication()" /> is called.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that will be completed when the <see cref="T:Microsoft.Extensions.Hosting.IHost" /> starts.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<Member MemberName="StopAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task StopAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task StopAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function StopAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member StopAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iHost.StopAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
<summary>
Attempts to gracefully stop the program.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that will be completed when the <see cref="T:Microsoft.Extensions.Hosting.IHost" /> stops.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
</Members>
</Type>