Microsoft.Extensions.Hosting.xml 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Hosting</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Hosting.BackgroundServiceExceptionBehavior">
  8. <summary>
  9. Specifies a behavior that the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> will honor if an
  10. unhandled exception occurs in one of its <see cref="T:Microsoft.Extensions.Hosting.BackgroundService"/> instances.
  11. </summary>
  12. </member>
  13. <member name="F:Microsoft.Extensions.Hosting.BackgroundServiceExceptionBehavior.StopHost">
  14. <summary>
  15. Stops the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> instance.
  16. </summary>
  17. <remarks>
  18. If a <see cref="T:Microsoft.Extensions.Hosting.BackgroundService"/> throws an exception, the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> instance stops, and the process continues.
  19. </remarks>
  20. </member>
  21. <member name="F:Microsoft.Extensions.Hosting.BackgroundServiceExceptionBehavior.Ignore">
  22. <summary>
  23. Ignore exceptions thrown in <see cref="T:Microsoft.Extensions.Hosting.BackgroundService"/>.
  24. </summary>
  25. <remarks>
  26. If a <see cref="T:Microsoft.Extensions.Hosting.BackgroundService"/> throws an exception, the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> will log the error, but otherwise ignore it.
  27. The <see cref="T:Microsoft.Extensions.Hosting.BackgroundService"/> is not restarted.
  28. </remarks>
  29. </member>
  30. <member name="P:Microsoft.Extensions.Hosting.ConsoleLifetimeOptions.SuppressStatusMessages">
  31. <summary>
  32. Indicates if host lifetime status messages should be suppressed such as on startup.
  33. The default is false.
  34. </summary>
  35. </member>
  36. <member name="T:Microsoft.Extensions.Hosting.Host">
  37. <summary>
  38. Provides convenience methods for creating instances of <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> with pre-configured defaults.
  39. </summary>
  40. </member>
  41. <member name="M:Microsoft.Extensions.Hosting.Host.CreateDefaultBuilder">
  42. <summary>
  43. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Hosting.HostBuilder"/> class with pre-configured defaults.
  44. </summary>
  45. <remarks>
  46. The following defaults are applied to the returned <see cref="T:Microsoft.Extensions.Hosting.HostBuilder"/>:
  47. <list type="bullet">
  48. <item><description>set the <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootPath"/> to the result of <see cref="M:System.IO.Directory.GetCurrentDirectory"/></description></item>
  49. <item><description>load host <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from "DOTNET_" prefixed environment variables</description></item>
  50. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from 'appsettings.json' and 'appsettings.[<see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/>].json'</description></item>
  51. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from User Secrets when <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/> is 'Development' using the entry assembly</description></item>
  52. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from environment variables</description></item>
  53. <item><description>configure the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to log to the console, debug, and event source output</description></item>
  54. <item><description>enables scope validation on the dependency injection container when <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/> is 'Development'</description></item>
  55. </list>
  56. </remarks>
  57. <returns>The initialized <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
  58. </member>
  59. <member name="M:Microsoft.Extensions.Hosting.Host.CreateDefaultBuilder(System.String[])">
  60. <summary>
  61. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Hosting.HostBuilder"/> class with pre-configured defaults.
  62. </summary>
  63. <remarks>
  64. The following defaults are applied to the returned <see cref="T:Microsoft.Extensions.Hosting.HostBuilder"/>:
  65. <list type="bullet">
  66. <item><description>set the <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootPath"/> to the result of <see cref="M:System.IO.Directory.GetCurrentDirectory"/></description></item>
  67. <item><description>load host <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from "DOTNET_" prefixed environment variables</description></item>
  68. <item><description>load host <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from supplied command line args</description></item>
  69. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from 'appsettings.json' and 'appsettings.[<see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/>].json'</description></item>
  70. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from User Secrets when <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/> is 'Development' using the entry assembly</description></item>
  71. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from environment variables</description></item>
  72. <item><description>load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from supplied command line args</description></item>
  73. <item><description>configure the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to log to the console, debug, and event source output</description></item>
  74. <item><description>enables scope validation on the dependency injection container when <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/> is 'Development'</description></item>
  75. </list>
  76. </remarks>
  77. <param name="args">The command line args.</param>
  78. <returns>The initialized <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
  79. </member>
  80. <member name="T:Microsoft.Extensions.Hosting.HostBuilder">
  81. <summary>
  82. A program initialization utility.
  83. </summary>
  84. </member>
  85. <member name="P:Microsoft.Extensions.Hosting.HostBuilder.Properties">
  86. <summary>
  87. A central location for sharing state between components during the host building process.
  88. </summary>
  89. </member>
  90. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.ConfigureHostConfiguration(System.Action{Microsoft.Extensions.Configuration.IConfigurationBuilder})">
  91. <summary>
  92. Set up the configuration for the builder itself. This will be used to initialize the <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>
  93. for use later in the build process. This can be called multiple times and the results will be additive.
  94. </summary>
  95. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  96. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
  97. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  98. </member>
  99. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.ConfigureAppConfiguration(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.Configuration.IConfigurationBuilder})">
  100. <summary>
  101. Sets up the configuration for the remainder of the build process and application. This can be called multiple times and
  102. the results will be additive. The results will be available at <see cref="P:Microsoft.Extensions.Hosting.HostBuilderContext.Configuration"/> for
  103. subsequent operations, as well as in <see cref="P:Microsoft.Extensions.Hosting.IHost.Services"/>.
  104. </summary>
  105. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  106. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
  107. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  108. </member>
  109. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})">
  110. <summary>
  111. Adds services to the container. This can be called multiple times and the results will be additive.
  112. </summary>
  113. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  114. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
  115. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  116. </member>
  117. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.UseServiceProviderFactory``1(Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0})">
  118. <summary>
  119. Overrides the factory used to create the service provider.
  120. </summary>
  121. <typeparam name="TContainerBuilder">The type of the builder to create.</typeparam>
  122. <param name="factory">A factory used for creating service providers.</param>
  123. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  124. </member>
  125. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.UseServiceProviderFactory``1(System.Func{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0}})">
  126. <summary>
  127. Overrides the factory used to create the service provider.
  128. </summary>
  129. <param name="factory">A factory used for creating service providers.</param>
  130. <typeparam name="TContainerBuilder">The type of the builder to create.</typeparam>
  131. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  132. </member>
  133. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.ConfigureContainer``1(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,``0})">
  134. <summary>
  135. Enables configuring the instantiated dependency container. This can be called multiple times and
  136. the results will be additive.
  137. </summary>
  138. <typeparam name="TContainerBuilder">The type of the builder to create.</typeparam>
  139. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  140. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
  141. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  142. </member>
  143. <member name="M:Microsoft.Extensions.Hosting.HostBuilder.Build">
  144. <summary>
  145. Run the given actions to initialize the host. This can only be called once.
  146. </summary>
  147. <returns>An initialized <see cref="T:Microsoft.Extensions.Hosting.IHost"/></returns>
  148. </member>
  149. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.UseEnvironment(Microsoft.Extensions.Hosting.IHostBuilder,System.String)">
  150. <summary>
  151. Specify the environment to be used by the host. To avoid the environment being overwritten by a default
  152. value, ensure this is called after defaults are configured.
  153. </summary>
  154. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to configure.</param>
  155. <param name="environment">The environment to host the application in.</param>
  156. <returns>The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
  157. </member>
  158. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.UseContentRoot(Microsoft.Extensions.Hosting.IHostBuilder,System.String)">
  159. <summary>
  160. Specify the content root directory to be used by the host. To avoid the content root directory being
  161. overwritten by a default value, ensure this is called after defaults are configured.
  162. </summary>
  163. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to configure.</param>
  164. <param name="contentRoot">Path to root directory of the application.</param>
  165. <returns>The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.UseDefaultServiceProvider(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.DependencyInjection.ServiceProviderOptions})">
  168. <summary>
  169. Specify the <see cref="T:System.IServiceProvider"/> to be the default one.
  170. </summary>
  171. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to configure.</param>
  172. <param name="configure"></param>
  173. <returns>The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
  174. </member>
  175. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.UseDefaultServiceProvider(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.ServiceProviderOptions})">
  176. <summary>
  177. Specify the <see cref="T:System.IServiceProvider"/> to be the default one.
  178. </summary>
  179. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to configure.</param>
  180. <param name="configure">The delegate that configures the <see cref="T:System.IServiceProvider"/>.</param>
  181. <returns>The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
  182. </member>
  183. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureLogging(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.Logging.ILoggingBuilder})">
  184. <summary>
  185. Adds a delegate for configuring the provided <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>. This may be called multiple times.
  186. </summary>
  187. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  188. <param name="configureLogging">The delegate that configures the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>.</param>
  189. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  190. </member>
  191. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureLogging(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Logging.ILoggingBuilder})">
  192. <summary>
  193. Adds a delegate for configuring the provided <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>. This may be called multiple times.
  194. </summary>
  195. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  196. <param name="configureLogging">The delegate that configures the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>.</param>
  197. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  198. </member>
  199. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureHostOptions(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.Hosting.HostOptions})">
  200. <summary>
  201. Adds a delegate for configuring the <see cref="T:Microsoft.Extensions.Hosting.HostOptions"/> of the <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.
  202. </summary>
  203. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  204. <param name="configureOptions">The delegate for configuring the <see cref="T:Microsoft.Extensions.Hosting.HostOptions"/>.</param>
  205. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  206. </member>
  207. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureHostOptions(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Hosting.HostOptions})">
  208. <summary>
  209. Adds a delegate for configuring the <see cref="T:Microsoft.Extensions.Hosting.HostOptions"/> of the <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.
  210. </summary>
  211. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  212. <param name="configureOptions">The delegate for configuring the <see cref="T:Microsoft.Extensions.Hosting.HostOptions"/>.</param>
  213. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  214. </member>
  215. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureAppConfiguration(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Configuration.IConfigurationBuilder})">
  216. <summary>
  217. Sets up the configuration for the remainder of the build process and application. This can be called multiple times and
  218. the results will be additive. The results will be available at <see cref="P:Microsoft.Extensions.Hosting.HostBuilderContext.Configuration"/> for
  219. subsequent operations, as well as in <see cref="P:Microsoft.Extensions.Hosting.IHost.Services"/>.
  220. </summary>
  221. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  222. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  223. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
  224. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  225. </member>
  226. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureServices(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
  227. <summary>
  228. Adds services to the container. This can be called multiple times and the results will be additive.
  229. </summary>
  230. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  231. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  232. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  233. </member>
  234. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureContainer``1(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{``0})">
  235. <summary>
  236. Enables configuring the instantiated dependency container. This can be called multiple times and
  237. the results will be additive.
  238. </summary>
  239. <typeparam name="TContainerBuilder"></typeparam>
  240. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  241. <param name="configureDelegate">The delegate for configuring the <typeparamref name="TContainerBuilder"/>.</param>
  242. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  243. </member>
  244. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.ConfigureDefaults(Microsoft.Extensions.Hosting.IHostBuilder,System.String[])">
  245. <summary>
  246. Configures an existing <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> instance with pre-configured defaults. This will overwrite
  247. previously configured values and is intended to be called before additional configuration calls.
  248. </summary>
  249. <remarks>
  250. The following defaults are applied to the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>:
  251. * set the <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootPath"/> to the result of <see cref="M:System.IO.Directory.GetCurrentDirectory"/>
  252. * load host <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from "DOTNET_" prefixed environment variables
  253. * load host <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from supplied command line args
  254. * load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from 'appsettings.json' and 'appsettings.[<see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/>].json'
  255. * load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from User Secrets when <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/> is 'Development' using the entry assembly
  256. * load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from environment variables
  257. * load app <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from supplied command line args
  258. * configure the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to log to the console, debug, and event source output
  259. * enables scope validation on the dependency injection container when <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/> is 'Development'
  260. </remarks>
  261. <param name="builder">The existing builder to configure.</param>
  262. <param name="args">The command line args.</param>
  263. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  264. </member>
  265. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.UseConsoleLifetime(Microsoft.Extensions.Hosting.IHostBuilder)">
  266. <summary>
  267. Listens for Ctrl+C or SIGTERM and calls <see cref="M:Microsoft.Extensions.Hosting.IHostApplicationLifetime.StopApplication"/> to start the shutdown process.
  268. This will unblock extensions like RunAsync and WaitForShutdownAsync.
  269. </summary>
  270. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  271. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  272. </member>
  273. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.UseConsoleLifetime(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Hosting.ConsoleLifetimeOptions})">
  274. <summary>
  275. Listens for Ctrl+C or SIGTERM and calls <see cref="M:Microsoft.Extensions.Hosting.IHostApplicationLifetime.StopApplication"/> to start the shutdown process.
  276. This will unblock extensions like RunAsync and WaitForShutdownAsync.
  277. </summary>
  278. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  279. <param name="configureOptions">The delegate for configuring the <see cref="T:Microsoft.Extensions.Hosting.Internal.ConsoleLifetime"/>.</param>
  280. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  281. </member>
  282. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.RunConsoleAsync(Microsoft.Extensions.Hosting.IHostBuilder,System.Threading.CancellationToken)">
  283. <summary>
  284. Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down.
  285. </summary>
  286. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  287. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the console.</param>
  288. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that only completes when the token is triggered or shutdown is triggered.</returns>
  289. </member>
  290. <member name="M:Microsoft.Extensions.Hosting.HostingHostBuilderExtensions.RunConsoleAsync(Microsoft.Extensions.Hosting.IHostBuilder,System.Action{Microsoft.Extensions.Hosting.ConsoleLifetimeOptions},System.Threading.CancellationToken)">
  291. <summary>
  292. Enables console support, builds and starts the host, and waits for Ctrl+C or SIGTERM to shut down.
  293. </summary>
  294. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder" /> to configure.</param>
  295. <param name="configureOptions">The delegate for configuring the <see cref="T:Microsoft.Extensions.Hosting.Internal.ConsoleLifetime"/>.</param>
  296. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the console.</param>
  297. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that only completes when the token is triggered or shutdown is triggered.</returns>
  298. </member>
  299. <member name="T:Microsoft.Extensions.Hosting.HostOptions">
  300. <summary>
  301. Options for <see cref="T:Microsoft.Extensions.Hosting.IHost"/>
  302. </summary>
  303. </member>
  304. <member name="P:Microsoft.Extensions.Hosting.HostOptions.ShutdownTimeout">
  305. <summary>
  306. The default timeout for <see cref="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)"/>.
  307. </summary>
  308. </member>
  309. <member name="P:Microsoft.Extensions.Hosting.HostOptions.BackgroundServiceExceptionBehavior">
  310. <summary>
  311. The behavior the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> will follow when any of
  312. its <see cref="T:Microsoft.Extensions.Hosting.BackgroundService"/> instances throw an unhandled exception.
  313. </summary>
  314. <remarks>
  315. Defaults to <see cref="F:Microsoft.Extensions.Hosting.BackgroundServiceExceptionBehavior.StopHost"/>.
  316. </remarks>
  317. </member>
  318. <member name="T:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime">
  319. <summary>
  320. Allows consumers to perform cleanup during a graceful shutdown.
  321. </summary>
  322. </member>
  323. <member name="P:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime.ApplicationStarted">
  324. <summary>
  325. Triggered when the application host has fully started and is about to wait
  326. for a graceful shutdown.
  327. </summary>
  328. </member>
  329. <member name="P:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime.ApplicationStopping">
  330. <summary>
  331. Triggered when the application host is performing a graceful shutdown.
  332. Request may still be in flight. Shutdown will block until this event completes.
  333. </summary>
  334. </member>
  335. <member name="P:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime.ApplicationStopped">
  336. <summary>
  337. Triggered when the application host is performing a graceful shutdown.
  338. All requests should be complete at this point. Shutdown will block
  339. until this event completes.
  340. </summary>
  341. </member>
  342. <member name="M:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime.StopApplication">
  343. <summary>
  344. Signals the ApplicationStopping event and blocks until it completes.
  345. </summary>
  346. </member>
  347. <member name="M:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime.NotifyStarted">
  348. <summary>
  349. Signals the ApplicationStarted event and blocks until it completes.
  350. </summary>
  351. </member>
  352. <member name="M:Microsoft.Extensions.Hosting.Internal.ApplicationLifetime.NotifyStopped">
  353. <summary>
  354. Signals the ApplicationStopped event and blocks until it completes.
  355. </summary>
  356. </member>
  357. <member name="T:Microsoft.Extensions.Hosting.Internal.ConsoleLifetime">
  358. <summary>
  359. Listens for Ctrl+C or SIGTERM and initiates shutdown.
  360. </summary>
  361. </member>
  362. <member name="T:Microsoft.Extensions.Hosting.Internal.HostingEnvironment">
  363. <summary>
  364. This API supports infrastructure and is not intended to be used
  365. directly from your code. This API may change or be removed in future releases.
  366. </summary>
  367. </member>
  368. <member name="T:Microsoft.Extensions.Hosting.Internal.NullLifetime">
  369. <summary>
  370. Minimalistic lifetime that does nothing.
  371. </summary>
  372. </member>
  373. <member name="T:Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions">
  374. <summary>
  375. Extension methods for adding configuration related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.
  376. </summary>
  377. </member>
  378. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderExtensions.ValidateOnStart``1(Microsoft.Extensions.Options.OptionsBuilder{``0})">
  379. <summary>
  380. Enforces options validation check on start rather than in runtime.
  381. </summary>
  382. <typeparam name="TOptions">The type of options.</typeparam>
  383. <param name="optionsBuilder">The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> to configure options instance.</param>
  384. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
  385. </member>
  386. <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
  387. <summary>
  388. Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
  389. single code artifact.
  390. </summary>
  391. <remarks>
  392. <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
  393. <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
  394. <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
  395. </remarks>
  396. </member>
  397. <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
  398. <summary>
  399. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
  400. class, specifying the category of the tool and the identifier for an analysis rule.
  401. </summary>
  402. <param name="category">The category for the attribute.</param>
  403. <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
  404. </member>
  405. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
  406. <summary>
  407. Gets the category identifying the classification of the attribute.
  408. </summary>
  409. <remarks>
  410. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
  411. for which a message suppression attribute applies.
  412. </remarks>
  413. </member>
  414. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
  415. <summary>
  416. Gets the identifier of the analysis tool rule to be suppressed.
  417. </summary>
  418. <remarks>
  419. Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
  420. properties form a unique check identifier.
  421. </remarks>
  422. </member>
  423. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
  424. <summary>
  425. Gets or sets the scope of the code that is relevant for the attribute.
  426. </summary>
  427. <remarks>
  428. The Scope property is an optional argument that specifies the metadata scope for which
  429. the attribute is relevant.
  430. </remarks>
  431. </member>
  432. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
  433. <summary>
  434. Gets or sets a fully qualified path that represents the target of the attribute.
  435. </summary>
  436. <remarks>
  437. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
  438. of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
  439. Because it is fully qualified, it can be long, particularly for targets such as parameters.
  440. The analysis tool user interface should be capable of automatically formatting the parameter.
  441. </remarks>
  442. </member>
  443. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
  444. <summary>
  445. Gets or sets an optional argument expanding on exclusion criteria.
  446. </summary>
  447. <remarks>
  448. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
  449. exclusion where the literal metadata target is not sufficiently precise. For example,
  450. the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
  451. and it may be desirable to suppress a violation against a statement in the method that will
  452. give a rule violation, but not against all statements in the method.
  453. </remarks>
  454. </member>
  455. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
  456. <summary>
  457. Gets or sets the justification for suppressing the code analysis message.
  458. </summary>
  459. </member>
  460. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
  461. <summary>
  462. Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
  463. for example through <see cref="N:System.Reflection"/>.
  464. </summary>
  465. <remarks>
  466. This allows tools to understand which members are being accessed during the execution
  467. of a program.
  468. This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
  469. When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
  470. that the string represents a fully qualified type name.
  471. When this attribute is applied to a class, interface, or struct, the members specified
  472. can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
  473. <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
  474. If the attribute is applied to a method it's treated as a special case and it implies
  475. the attribute should be applied to the "this" parameter of the method. As such the attribute
  476. should only be used on instance methods of types assignable to System.Type (or string, but no methods
  477. will use it there).
  478. </remarks>
  479. </member>
  480. <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
  481. <summary>
  482. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
  483. with the specified member types.
  484. </summary>
  485. <param name="memberTypes">The types of members dynamically accessed.</param>
  486. </member>
  487. <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
  488. <summary>
  489. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  490. of members dynamically accessed.
  491. </summary>
  492. </member>
  493. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  494. <summary>
  495. Specifies the types of members that are dynamically accessed.
  496. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  497. bitwise combination of its member values.
  498. </summary>
  499. </member>
  500. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  501. <summary>
  502. Specifies no members.
  503. </summary>
  504. </member>
  505. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  506. <summary>
  507. Specifies the default, parameterless public constructor.
  508. </summary>
  509. </member>
  510. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  511. <summary>
  512. Specifies all public constructors.
  513. </summary>
  514. </member>
  515. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  516. <summary>
  517. Specifies all non-public constructors.
  518. </summary>
  519. </member>
  520. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  521. <summary>
  522. Specifies all public methods.
  523. </summary>
  524. </member>
  525. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  526. <summary>
  527. Specifies all non-public methods.
  528. </summary>
  529. </member>
  530. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  531. <summary>
  532. Specifies all public fields.
  533. </summary>
  534. </member>
  535. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  536. <summary>
  537. Specifies all non-public fields.
  538. </summary>
  539. </member>
  540. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  541. <summary>
  542. Specifies all public nested types.
  543. </summary>
  544. </member>
  545. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  546. <summary>
  547. Specifies all non-public nested types.
  548. </summary>
  549. </member>
  550. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  551. <summary>
  552. Specifies all public properties.
  553. </summary>
  554. </member>
  555. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  556. <summary>
  557. Specifies all non-public properties.
  558. </summary>
  559. </member>
  560. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  561. <summary>
  562. Specifies all public events.
  563. </summary>
  564. </member>
  565. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  566. <summary>
  567. Specifies all non-public events.
  568. </summary>
  569. </member>
  570. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  571. <summary>
  572. Specifies all interfaces implemented by the type.
  573. </summary>
  574. </member>
  575. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  576. <summary>
  577. Specifies all members.
  578. </summary>
  579. </member>
  580. <member name="P:System.SR.BackgroundServiceExceptionStoppedHost">
  581. <summary>The HostOptions.BackgroundServiceExceptionBehavior is configured to StopHost. A BackgroundService has thrown an unhandled exception, and the IHost instance is stopping. To avoid this behavior, configure this to Ignore; however the BackgroundService will no ...</summary>
  582. </member>
  583. <member name="P:System.SR.BuildCalled">
  584. <summary>Build can only be called once.</summary>
  585. </member>
  586. <member name="P:System.SR.CreateBuilderCallBeforeCreateServiceProvider">
  587. <summary>CreateBuilder must be called before CreateServiceProvider</summary>
  588. </member>
  589. <member name="P:System.SR.NullIServiceProvider">
  590. <summary>The IServiceProviderFactory returned a null IServiceProvider</summary>
  591. </member>
  592. <member name="P:System.SR.ResolverReturnedNull">
  593. <summary>The resolver returned a null IServiceProviderFactory</summary>
  594. </member>
  595. <member name="T:System.Runtime.Versioning.OSPlatformAttribute">
  596. <summary>
  597. Base type for all platform-specific API attributes.
  598. </summary>
  599. </member>
  600. <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
  601. <summary>
  602. Records the platform that the project targeted.
  603. </summary>
  604. </member>
  605. <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
  606. <summary>
  607. Records the operating system (and minimum version) that supports an API. Multiple attributes can be
  608. applied to indicate support on multiple operating systems.
  609. </summary>
  610. <remarks>
  611. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
  612. or use guards to prevent calls to APIs on unsupported operating systems.
  613. A given platform should only be specified once.
  614. </remarks>
  615. </member>
  616. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
  617. <summary>
  618. Marks APIs that were removed in a given operating system version.
  619. </summary>
  620. <remarks>
  621. Primarily used by OS bindings to indicate APIs that are only available in
  622. earlier versions.
  623. </remarks>
  624. </member>
  625. <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
  626. <summary>
  627. Annotates a custom guard field, property or method with a supported platform name and optional version.
  628. Multiple attributes can be applied to indicate guard for multiple supported platforms.
  629. </summary>
  630. <remarks>
  631. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
  632. and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
  633. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  634. </remarks>
  635. </member>
  636. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
  637. <summary>
  638. Annotates the custom guard field, property or method with an unsupported platform name and optional version.
  639. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
  640. </summary>
  641. <remarks>
  642. Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
  643. and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
  644. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  645. </remarks>
  646. </member>
  647. </members>
  648. </doc>