1 <?xml version="1.0"?>
\r
4 <name>Microsoft.AspNetCore.Hosting.Abstractions</name>
\r
7 <member name="T:Microsoft.AspNetCore.Hosting.EnvironmentName">
\r
9 Commonly used environment names.
\r
12 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseConfiguration(Microsoft.AspNetCore.Hosting.IWebHostBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
\r
14 Use the given configuration settings on the web host.
\r
16 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
17 <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> containing settings to be used.</param>
\r
18 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
20 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.CaptureStartupErrors(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Boolean)">
\r
22 Set whether startup errors should be captured in the configuration settings of the web host.
\r
23 When enabled, startup exceptions will be caught and an error page will be returned. If disabled, startup exceptions will be propagated.
\r
25 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
26 <param name="captureStartupErrors"><c>true</c> to use startup error page; otherwise <c>false</c>.</param>
\r
27 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
29 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseStartup(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
\r
31 Specify the assembly containing the startup type to be used by the web host.
\r
33 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
34 <param name="startupAssemblyName">The name of the assembly containing the startup type.</param>
\r
35 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
37 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseServer(Microsoft.AspNetCore.Hosting.IWebHostBuilder,Microsoft.AspNetCore.Hosting.Server.IServer)">
\r
39 Specify the server to be used by the web host.
\r
41 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
42 <param name="server">The <see cref="T:Microsoft.AspNetCore.Hosting.Server.IServer"/> to be used.</param>
\r
43 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
45 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseEnvironment(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
\r
47 Specify the environment to be used by the web host.
\r
49 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
50 <param name="environment">The environment to host the application in.</param>
\r
51 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
53 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseContentRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
\r
55 Specify the content root directory to be used by the web host.
\r
57 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
58 <param name="contentRoot">Path to root directory of the application.</param>
\r
59 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
61 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseWebRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
\r
63 Specify the webroot directory to be used by the web host.
\r
65 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
66 <param name="webRoot">Path to the root directory used by the web server.</param>
\r
67 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
69 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseUrls(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String[])">
\r
71 Specify the urls the web host will listen on.
\r
73 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
74 <param name="urls">The urls the hosted application will listen on.</param>
\r
75 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
77 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.PreferHostingUrls(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Boolean)">
\r
79 Indicate whether the host should listen on the URLs configured on the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>
\r
80 instead of those configured on the <see cref="T:Microsoft.AspNetCore.Hosting.Server.IServer"/>.
\r
82 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
83 <param name="preferHostingUrls"><c>true</c> to prefer URLs configured on the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>; otherwise <c>false</c>.</param>
\r
84 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
86 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.SuppressStatusMessages(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Boolean)">
\r
88 Specify if startup status messages should be suppressed.
\r
90 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
91 <param name="suppressStatusMessages"><c>true</c> to suppress writing of hosting startup status messages; otherwise <c>false</c>.</param>
\r
92 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
94 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseShutdownTimeout(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.TimeSpan)">
\r
96 Specify the amount of time to wait for the web host to shutdown.
\r
98 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
\r
99 <param name="timeout">The amount of time to wait for server shutdown.</param>
\r
100 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
102 <member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.Start(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String[])">
\r
104 Start the web host and listen on the specified urls.
\r
106 <param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to start.</param>
\r
107 <param name="urls">The urls the hosted application will listen on.</param>
\r
108 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
110 <member name="T:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions">
\r
112 Extension methods for <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.
\r
115 <member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsDevelopment(Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
\r
117 Checks if the current hosting environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Development"/>.
\r
119 <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
\r
120 <returns>True if the environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Development"/>, otherwise false.</returns>
\r
122 <member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsStaging(Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
\r
124 Checks if the current hosting environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Staging"/>.
\r
126 <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
\r
127 <returns>True if the environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Staging"/>, otherwise false.</returns>
\r
129 <member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsProduction(Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
\r
131 Checks if the current hosting environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Production"/>.
\r
133 <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
\r
134 <returns>True if the environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Production"/>, otherwise false.</returns>
\r
136 <member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsEnvironment(Microsoft.AspNetCore.Hosting.IHostingEnvironment,System.String)">
\r
138 Compares the current hosting environment name against the specified value.
\r
140 <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
\r
141 <param name="environmentName">Environment name to validate against.</param>
\r
142 <returns>True if the specified name is the same as the current environment, otherwise false.</returns>
\r
144 <member name="T:Microsoft.AspNetCore.Hosting.HostingStartupAttribute">
\r
146 Marker attribute indicating an implementation of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingStartup"/> that will be loaded and executed when building an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.
\r
149 <member name="M:Microsoft.AspNetCore.Hosting.HostingStartupAttribute.#ctor(System.Type)">
\r
151 Constructs the <see cref="T:Microsoft.AspNetCore.Hosting.HostingStartupAttribute"/> with the specified type.
\r
153 <param name="hostingStartupType">A type that implements <see cref="T:Microsoft.AspNetCore.Hosting.IHostingStartup"/>.</param>
\r
155 <member name="P:Microsoft.AspNetCore.Hosting.HostingStartupAttribute.HostingStartupType">
\r
157 The implementation of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingStartup"/> that should be loaded when
\r
158 starting an application.
\r
161 <member name="T:Microsoft.AspNetCore.Hosting.IApplicationLifetime">
\r
163 Allows consumers to perform cleanup during a graceful shutdown.
\r
165 This type is obsolete and will be removed in a future version.
\r
166 The recommended alternative is Microsoft.Extensions.Hosting.IHostApplicationLifetime.
\r
170 <member name="P:Microsoft.AspNetCore.Hosting.IApplicationLifetime.ApplicationStarted">
\r
172 Triggered when the application host has fully started and is about to wait
\r
173 for a graceful shutdown.
\r
176 <member name="P:Microsoft.AspNetCore.Hosting.IApplicationLifetime.ApplicationStopping">
\r
178 Triggered when the application host is performing a graceful shutdown.
\r
179 Requests may still be in flight. Shutdown will block until this event completes.
\r
182 <member name="P:Microsoft.AspNetCore.Hosting.IApplicationLifetime.ApplicationStopped">
\r
184 Triggered when the application host is performing a graceful shutdown.
\r
185 All requests should be complete at this point. Shutdown will block
\r
186 until this event completes.
\r
189 <member name="M:Microsoft.AspNetCore.Hosting.IApplicationLifetime.StopApplication">
\r
191 Requests termination of the current application.
\r
194 <member name="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment">
\r
196 Provides information about the web hosting environment an application is running in.
\r
198 This type is obsolete and will be removed in a future version.
\r
199 The recommended alternative is Microsoft.AspNetCore.Hosting.IWebHostEnvironment.
\r
203 <member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName">
\r
205 Gets or sets the name of the environment. The host automatically sets this property to the value
\r
206 of the "ASPNETCORE_ENVIRONMENT" environment variable, or "environment" as specified in any other configuration source.
\r
209 <member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ApplicationName">
\r
211 Gets or sets the name of the application. This property is automatically set by the host to the assembly containing
\r
212 the application entry point.
\r
215 <member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.WebRootPath">
\r
217 Gets or sets the absolute path to the directory that contains the web-servable application content files.
\r
220 <member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.WebRootFileProvider">
\r
222 Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.WebRootPath"/>.
\r
225 <member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath">
\r
227 Gets or sets the absolute path to the directory that contains the application content files.
\r
230 <member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootFileProvider">
\r
232 Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath"/>.
\r
235 <member name="T:Microsoft.AspNetCore.Hosting.IHostingStartup">
\r
237 Represents platform specific configuration that will be applied to a <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> when building an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.
\r
240 <member name="M:Microsoft.AspNetCore.Hosting.IHostingStartup.Configure(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
\r
242 Configure the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
\r
245 Configure is intended to be called before user code, allowing a user to overwrite any changes made.
\r
247 <param name="builder"></param>
\r
249 <member name="T:Microsoft.AspNetCore.Hosting.IStartupConfigureContainerFilter`1">
\r
251 This API supports the ASP.NET Core infrastructure and is not intended to be used
\r
252 directly from your code. This API may change or be removed in future releases.
\r
255 <member name="T:Microsoft.AspNetCore.Hosting.IStartupConfigureServicesFilter">
\r
257 This API supports the ASP.NET Core infrastructure and is not intended to be used
\r
258 directly from your code. This API may change or be removed in future releases.
\r
261 <member name="T:Microsoft.AspNetCore.Hosting.IWebHost">
\r
263 Represents a configured web host.
\r
266 <member name="P:Microsoft.AspNetCore.Hosting.IWebHost.ServerFeatures">
\r
268 The <see cref="T:Microsoft.AspNetCore.Http.Features.IFeatureCollection"/> exposed by the configured server.
\r
271 <member name="P:Microsoft.AspNetCore.Hosting.IWebHost.Services">
\r
273 The <see cref="T:System.IServiceProvider"/> for the host.
\r
276 <member name="M:Microsoft.AspNetCore.Hosting.IWebHost.Start">
\r
278 Starts listening on the configured addresses.
\r
281 <member name="M:Microsoft.AspNetCore.Hosting.IWebHost.StartAsync(System.Threading.CancellationToken)">
\r
283 Starts listening on the configured addresses.
\r
285 <param name="cancellationToken">Used to abort program start.</param>
\r
286 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> starts.</returns>
\r
288 <member name="M:Microsoft.AspNetCore.Hosting.IWebHost.StopAsync(System.Threading.CancellationToken)">
\r
290 Attempt to gracefully stop the host.
\r
292 <param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
\r
293 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> stops.</returns>
\r
295 <member name="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder">
\r
297 A builder for <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.
\r
300 <member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.Build">
\r
302 Builds an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> which hosts a web application.
\r
305 <member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.ConfigureAppConfiguration(System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.Configuration.IConfigurationBuilder})">
\r
307 Adds a delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
\r
309 <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> that will be used to construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.</param>
\r
310 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
312 The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> and <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> on the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilderContext"/> are uninitialized at this stage.
\r
313 The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> is pre-populated with the settings of the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
\r
316 <member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
\r
318 Adds a delegate for configuring additional services for the host or web application. This may be called
\r
321 <param name="configureServices">A delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
\r
322 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
324 <member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.ConfigureServices(System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})">
\r
326 Adds a delegate for configuring additional services for the host or web application. This may be called
\r
329 <param name="configureServices">A delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
\r
330 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
332 <member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.GetSetting(System.String)">
\r
334 Get the setting value from the configuration.
\r
336 <param name="key">The key of the setting to look up.</param>
\r
337 <returns>The value the setting currently contains.</returns>
\r
339 <member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.UseSetting(System.String,System.String)">
\r
341 Add or replace a setting in the configuration.
\r
343 <param name="key">The key of the setting to add or replace.</param>
\r
344 <param name="value">The value of the setting to add or replace.</param>
\r
345 <returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
\r
347 <member name="T:Microsoft.AspNetCore.Hosting.IWebHostEnvironment">
\r
349 Provides information about the web hosting environment an application is running in.
\r
352 <member name="P:Microsoft.AspNetCore.Hosting.IWebHostEnvironment.WebRootPath">
\r
354 Gets or sets the absolute path to the directory that contains the web-servable application content files.
\r
357 <member name="P:Microsoft.AspNetCore.Hosting.IWebHostEnvironment.WebRootFileProvider">
\r
359 Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.AspNetCore.Hosting.IWebHostEnvironment.WebRootPath"/>.
\r
362 <member name="T:Microsoft.AspNetCore.Hosting.WebHostBuilderContext">
\r
364 Context containing the common services on the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />. Some properties may be null until set by the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
\r
367 <member name="P:Microsoft.AspNetCore.Hosting.WebHostBuilderContext.HostingEnvironment">
\r
369 The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostEnvironment" /> initialized by the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
\r
372 <member name="P:Microsoft.AspNetCore.Hosting.WebHostBuilderContext.Configuration">
\r
374 The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> containing the merged configuration of the application and the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
\r