-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
SystemdHostBuilderExtensions.xml
114 lines (114 loc) · 7.81 KB
/
SystemdHostBuilderExtensions.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
<Type Name="SystemdHostBuilderExtensions" FullName="Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions">
<TypeSignature Language="C#" Value="public static class SystemdHostBuilderExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit SystemdHostBuilderExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module SystemdHostBuilderExtensions" />
<TypeSignature Language="F#" Value="type SystemdHostBuilderExtensions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class SystemdHostBuilderExtensions abstract sealed" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Systemd</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.1</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Extension methods for setting up <see cref="T:Microsoft.Extensions.Hosting.Systemd.SystemdLifetime" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddSystemd">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddSystemd (this Microsoft.Extensions.DependencyInjection.IServiceCollection services);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.DependencyInjection.IServiceCollection AddSystemd(class Microsoft.Extensions.DependencyInjection.IServiceCollection services) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions.AddSystemd(Microsoft.Extensions.DependencyInjection.IServiceCollection)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddSystemd (services As IServiceCollection) As IServiceCollection" />
<MemberSignature Language="F#" Value="static member AddSystemd : Microsoft.Extensions.DependencyInjection.IServiceCollection -> Microsoft.Extensions.DependencyInjection.IServiceCollection" Usage="Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions.AddSystemd services" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::DependencyInjection::IServiceCollection ^ AddSystemd(Microsoft::Extensions::DependencyInjection::IServiceCollection ^ services);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Systemd</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.DependencyInjection.IServiceCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="services" Type="Microsoft.Extensions.DependencyInjection.IServiceCollection" RefType="this" />
</Parameters>
<Docs>
<param name="services">
The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> used to build the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
For example, <see cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilder.Services" /> or the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> passed to the
<see cref="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})" /> callback.
</param>
<summary>
Configures the lifetime of the <see cref="T:Microsoft.Extensions.Hosting.IHost" /> built from <paramref name="services" /> to
<see cref="T:Microsoft.Extensions.Hosting.Systemd.SystemdLifetime" />, provides notification messages for application started
and stopping, and configures console logging to the systemd format.
</summary>
<returns>The <paramref name="services" /> instance for chaining.</returns>
<remarks>
<para>
This is context aware and will only activate if it detects the process is running
as a systemd Service.
</para>
<para>
The systemd service file must be configured with <c>Type=notify</c> to enable
notifications. See <see href="https://www.freedesktop.org/software/systemd/man/systemd.service.html" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="UseSystemd">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.Hosting.IHostBuilder UseSystemd (this Microsoft.Extensions.Hosting.IHostBuilder hostBuilder);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.Hosting.IHostBuilder UseSystemd(class Microsoft.Extensions.Hosting.IHostBuilder hostBuilder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions.UseSystemd(Microsoft.Extensions.Hosting.IHostBuilder)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UseSystemd (hostBuilder As IHostBuilder) As IHostBuilder" />
<MemberSignature Language="F#" Value="static member UseSystemd : Microsoft.Extensions.Hosting.IHostBuilder -> Microsoft.Extensions.Hosting.IHostBuilder" Usage="Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions.UseSystemd hostBuilder" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Hosting::IHostBuilder ^ UseSystemd(Microsoft::Extensions::Hosting::IHostBuilder ^ hostBuilder);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Systemd</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Hosting.IHostBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostBuilder" Type="Microsoft.Extensions.Hosting.IHostBuilder" RefType="this" />
</Parameters>
<Docs>
<param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
<summary>
Configures the <see cref="T:Microsoft.Extensions.Hosting.IHost" /> lifetime to <see cref="T:Microsoft.Extensions.Hosting.Systemd.SystemdLifetime" />,
provides notification messages for application started and stopping,
and configures console logging to the systemd format.
</summary>
<returns>The <paramref name="hostBuilder" /> instance for chaining.</returns>
<remarks>
<para>
This is context aware and will only activate if it detects the process is running
as a systemd Service.
</para>
<para>
The systemd service file must be configured with <c>Type=notify</c> to enable
notifications. See https://www.freedesktop.org/software/systemd/man/systemd.service.html.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>