-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WindowsServiceLifetime.xml
259 lines (259 loc) · 21.6 KB
/
WindowsServiceLifetime.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
<Type Name="WindowsServiceLifetime" FullName="Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime">
<TypeSignature Language="C#" Value="public class WindowsServiceLifetime : System.ServiceProcess.ServiceBase, Microsoft.Extensions.Hosting.IHostLifetime" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WindowsServiceLifetime extends System.ServiceProcess.ServiceBase implements class Microsoft.Extensions.Hosting.IHostLifetime" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime" />
<TypeSignature Language="VB.NET" Value="Public Class WindowsServiceLifetime
Inherits ServiceBase
Implements IHostLifetime" />
<TypeSignature Language="F#" Value="type WindowsServiceLifetime = class
 inherit ServiceBase
 interface IHostLifetime" />
<TypeSignature Language="C++ CLI" Value="public ref class WindowsServiceLifetime : System::ServiceProcess::ServiceBase, Microsoft::Extensions::Hosting::IHostLifetime" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ServiceProcess.ServiceBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Extensions.Hosting.IHostLifetime</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
<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>Listens for shutdown signal and tracks the status of the Windows service.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WindowsServiceLifetime (Microsoft.Extensions.Hosting.IHostEnvironment environment, Microsoft.Extensions.Hosting.IHostApplicationLifetime applicationLifetime, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory, Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.HostOptions> optionsAccessor);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.Hosting.IHostEnvironment environment, class Microsoft.Extensions.Hosting.IHostApplicationLifetime applicationLifetime, class Microsoft.Extensions.Logging.ILoggerFactory loggerFactory, class Microsoft.Extensions.Options.IOptions`1<class Microsoft.Extensions.Hosting.HostOptions> optionsAccessor) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.#ctor(Microsoft.Extensions.Hosting.IHostEnvironment,Microsoft.Extensions.Hosting.IHostApplicationLifetime,Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Hosting.HostOptions})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (environment As IHostEnvironment, applicationLifetime As IHostApplicationLifetime, loggerFactory As ILoggerFactory, optionsAccessor As IOptions(Of HostOptions))" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime : Microsoft.Extensions.Hosting.IHostEnvironment * Microsoft.Extensions.Hosting.IHostApplicationLifetime * Microsoft.Extensions.Logging.ILoggerFactory * Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.HostOptions> -> Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime" Usage="new Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime (environment, applicationLifetime, loggerFactory, optionsAccessor)" />
<MemberSignature Language="C++ CLI" Value="public:
 WindowsServiceLifetime(Microsoft::Extensions::Hosting::IHostEnvironment ^ environment, Microsoft::Extensions::Hosting::IHostApplicationLifetime ^ applicationLifetime, Microsoft::Extensions::Logging::ILoggerFactory ^ loggerFactory, Microsoft::Extensions::Options::IOptions<Microsoft::Extensions::Hosting::HostOptions ^> ^ optionsAccessor);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="environment" Type="Microsoft.Extensions.Hosting.IHostEnvironment" />
<Parameter Name="applicationLifetime" Type="Microsoft.Extensions.Hosting.IHostApplicationLifetime" />
<Parameter Name="loggerFactory" Type="Microsoft.Extensions.Logging.ILoggerFactory" />
<Parameter Name="optionsAccessor" Type="Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.HostOptions>" />
</Parameters>
<Docs>
<param name="environment">Information about the host.</param>
<param name="applicationLifetime">The <see cref="T:Microsoft.Extensions.Hosting.IHostApplicationLifetime" /> that tracks the service lifetime.</param>
<param name="loggerFactory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> used to instantiate the lifetime logger.</param>
<param name="optionsAccessor">The <see cref="T:Microsoft.Extensions.Options.IOptions`1" /> containing options for the service.</param>
<summary>Initializes a new <see cref="T:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WindowsServiceLifetime (Microsoft.Extensions.Hosting.IHostEnvironment environment, Microsoft.Extensions.Hosting.IHostApplicationLifetime applicationLifetime, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory, Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.HostOptions> optionsAccessor, Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.WindowsServiceLifetimeOptions> windowsServiceOptionsAccessor);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.Hosting.IHostEnvironment environment, class Microsoft.Extensions.Hosting.IHostApplicationLifetime applicationLifetime, class Microsoft.Extensions.Logging.ILoggerFactory loggerFactory, class Microsoft.Extensions.Options.IOptions`1<class Microsoft.Extensions.Hosting.HostOptions> optionsAccessor, class Microsoft.Extensions.Options.IOptions`1<class Microsoft.Extensions.Hosting.WindowsServiceLifetimeOptions> windowsServiceOptionsAccessor) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.#ctor(Microsoft.Extensions.Hosting.IHostEnvironment,Microsoft.Extensions.Hosting.IHostApplicationLifetime,Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Hosting.HostOptions},Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Hosting.WindowsServiceLifetimeOptions})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (environment As IHostEnvironment, applicationLifetime As IHostApplicationLifetime, loggerFactory As ILoggerFactory, optionsAccessor As IOptions(Of HostOptions), windowsServiceOptionsAccessor As IOptions(Of WindowsServiceLifetimeOptions))" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime : Microsoft.Extensions.Hosting.IHostEnvironment * Microsoft.Extensions.Hosting.IHostApplicationLifetime * Microsoft.Extensions.Logging.ILoggerFactory * Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.HostOptions> * Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.WindowsServiceLifetimeOptions> -> Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime" Usage="new Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime (environment, applicationLifetime, loggerFactory, optionsAccessor, windowsServiceOptionsAccessor)" />
<MemberSignature Language="C++ CLI" Value="public:
 WindowsServiceLifetime(Microsoft::Extensions::Hosting::IHostEnvironment ^ environment, Microsoft::Extensions::Hosting::IHostApplicationLifetime ^ applicationLifetime, Microsoft::Extensions::Logging::ILoggerFactory ^ loggerFactory, Microsoft::Extensions::Options::IOptions<Microsoft::Extensions::Hosting::HostOptions ^> ^ optionsAccessor, Microsoft::Extensions::Options::IOptions<Microsoft::Extensions::Hosting::WindowsServiceLifetimeOptions ^> ^ windowsServiceOptionsAccessor);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="environment" Type="Microsoft.Extensions.Hosting.IHostEnvironment" />
<Parameter Name="applicationLifetime" Type="Microsoft.Extensions.Hosting.IHostApplicationLifetime" />
<Parameter Name="loggerFactory" Type="Microsoft.Extensions.Logging.ILoggerFactory" />
<Parameter Name="optionsAccessor" Type="Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.HostOptions>" />
<Parameter Name="windowsServiceOptionsAccessor" Type="Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Hosting.WindowsServiceLifetimeOptions>" />
</Parameters>
<Docs>
<param name="environment">To be added.</param>
<param name="applicationLifetime">To be added.</param>
<param name="loggerFactory">To be added.</param>
<param name="optionsAccessor">To be added.</param>
<param name="windowsServiceOptionsAccessor">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="windowsServiceLifetime.Dispose disposing" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void Dispose(bool disposing);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<see langword="true" /> only when called from <see cref="M:System.IDisposable.Dispose" />; otherwise, <see langword="false" />.</param>
<summary>Releases the resources used by the <see cref="T:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnShutdown">
<MemberSignature Language="C#" Value="protected override void OnShutdown ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnShutdown() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.OnShutdown" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnShutdown ()" />
<MemberSignature Language="F#" Value="override this.OnShutdown : unit -> unit" Usage="windowsServiceLifetime.OnShutdown " />
<MemberSignature Language="C++ CLI" Value="protected:
 override void OnShutdown();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnStart">
<MemberSignature Language="C#" Value="protected override void OnStart (string[] args);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnStart(string[] args) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.OnStart(System.String[])" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnStart (args As String())" />
<MemberSignature Language="F#" Value="override this.OnStart : string[] -> unit" Usage="windowsServiceLifetime.OnStart args" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void OnStart(cli::array <System::String ^> ^ args);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="args" Type="System.String[]" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="OnStop">
<MemberSignature Language="C#" Value="protected override void OnStop ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnStop() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.OnStop" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnStop ()" />
<MemberSignature Language="F#" Value="override this.OnStop : unit -> unit" Usage="windowsServiceLifetime.OnStop " />
<MemberSignature Language="C++ CLI" Value="protected:
 override void OnStop();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Executes when a Stop command is sent to the service by the Service Control Manager (SCM).
Triggers <see cref="P:Microsoft.Extensions.Hosting.IHostApplicationLifetime.ApplicationStopping" /> and waits for <see cref="P:Microsoft.Extensions.Hosting.IHostApplicationLifetime.ApplicationStopped" />.
Shortly after this method returns, the Service will be marked as stopped in SCM and the process may exit at any point.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StopAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task StopAsync (System.Threading.CancellationToken cancellationToken);" />
<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.WindowsServices.WindowsServiceLifetime.StopAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function StopAsync (cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="abstract member StopAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.StopAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="windowsServiceLifetime.StopAsync cancellationToken" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::Threading::Tasks::Task ^ StopAsync(System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</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="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A cancellation token that indicates when stop should no longer be graceful.</param>
<summary>Asynchronously stops and shuts down the host. This method is called from <see cref="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)" />.</summary>
<returns>A task that represents the asynchronous stop operation.</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="WaitForStartAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task WaitForStartAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task WaitForStartAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.WindowsServices.WindowsServiceLifetime.WaitForStartAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function WaitForStartAsync (cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="abstract member WaitForStartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WaitForStartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="windowsServiceLifetime.WaitForStartAsync cancellationToken" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::Threading::Tasks::Task ^ WaitForStartAsync(System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.WindowsServices</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="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A cancellation token that indicates when stop should no longer be graceful.</param>
<summary>Asynchronously waits until start is complete before continuing. This method is called at the beginning of <see cref="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)" />. This can be used to delay startup until signaled by an external event.</summary>
<returns>A task that represents the asynchronous waiting for start operation.</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>