Microsoft.Extensions.Hosting.Abstractions.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Hosting.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Hosting.BackgroundService">
  8. <summary>
  9. Base class for implementing a long running <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/>.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Hosting.BackgroundService.ExecuteTask">
  13. <summary>
  14. Gets the Task that executes the background operation.
  15. </summary>
  16. <remarks>
  17. Will return <see langword="null"/> if the background operation hasn't started.
  18. </remarks>
  19. </member>
  20. <member name="M:Microsoft.Extensions.Hosting.BackgroundService.ExecuteAsync(System.Threading.CancellationToken)">
  21. <summary>
  22. This method is called when the <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> starts. The implementation should return a task that represents
  23. the lifetime of the long running operation(s) being performed.
  24. </summary>
  25. <param name="stoppingToken">Triggered when <see cref="M:Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken)"/> is called.</param>
  26. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the long running operations.</returns>
  27. </member>
  28. <member name="M:Microsoft.Extensions.Hosting.BackgroundService.StartAsync(System.Threading.CancellationToken)">
  29. <summary>
  30. Triggered when the application host is ready to start the service.
  31. </summary>
  32. <param name="cancellationToken">Indicates that the start process has been aborted.</param>
  33. </member>
  34. <member name="M:Microsoft.Extensions.Hosting.BackgroundService.StopAsync(System.Threading.CancellationToken)">
  35. <summary>
  36. Triggered when the application host is performing a graceful shutdown.
  37. </summary>
  38. <param name="cancellationToken">Indicates that the shutdown process should no longer be graceful.</param>
  39. </member>
  40. <member name="T:Microsoft.Extensions.Hosting.EnvironmentName">
  41. <summary>
  42. Commonly used environment names.
  43. <para>
  44. This type is obsolete and will be removed in a future version.
  45. The recommended alternative is Microsoft.Extensions.Hosting.Environments.
  46. </para>
  47. </summary>
  48. </member>
  49. <member name="T:Microsoft.Extensions.Hosting.Environments">
  50. <summary>
  51. Commonly used environment names.
  52. </summary>
  53. </member>
  54. <member name="T:Microsoft.Extensions.Hosting.HostBuilderContext">
  55. <summary>
  56. Context containing the common services on the <see cref="T:Microsoft.Extensions.Hosting.IHost" />. Some properties may be null until set by the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
  57. </summary>
  58. </member>
  59. <member name="P:Microsoft.Extensions.Hosting.HostBuilderContext.HostingEnvironment">
  60. <summary>
  61. The <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment" /> initialized by the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
  62. </summary>
  63. </member>
  64. <member name="P:Microsoft.Extensions.Hosting.HostBuilderContext.Configuration">
  65. <summary>
  66. The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> containing the merged configuration of the application and the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
  67. </summary>
  68. </member>
  69. <member name="P:Microsoft.Extensions.Hosting.HostBuilderContext.Properties">
  70. <summary>
  71. A central location for sharing state between components during the host building process.
  72. </summary>
  73. </member>
  74. <member name="T:Microsoft.Extensions.Hosting.HostDefaults">
  75. <summary>
  76. Constants for HostBuilder configuration keys.
  77. </summary>
  78. </member>
  79. <member name="F:Microsoft.Extensions.Hosting.HostDefaults.ApplicationKey">
  80. <summary>
  81. The configuration key used to set <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ApplicationName"/>.
  82. </summary>
  83. </member>
  84. <member name="F:Microsoft.Extensions.Hosting.HostDefaults.EnvironmentKey">
  85. <summary>
  86. The configuration key used to set <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName"/>.
  87. </summary>
  88. </member>
  89. <member name="F:Microsoft.Extensions.Hosting.HostDefaults.ContentRootKey">
  90. <summary>
  91. The configuration key used to set <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootPath"/>
  92. and <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootFileProvider"/>.
  93. </summary>
  94. </member>
  95. <member name="T:Microsoft.Extensions.Hosting.HostEnvironmentEnvExtensions">
  96. <summary>
  97. Extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>.
  98. </summary>
  99. </member>
  100. <member name="M:Microsoft.Extensions.Hosting.HostEnvironmentEnvExtensions.IsDevelopment(Microsoft.Extensions.Hosting.IHostEnvironment)">
  101. <summary>
  102. Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development"/>.
  103. </summary>
  104. <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>.</param>
  105. <returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development"/>, otherwise false.</returns>
  106. </member>
  107. <member name="M:Microsoft.Extensions.Hosting.HostEnvironmentEnvExtensions.IsStaging(Microsoft.Extensions.Hosting.IHostEnvironment)">
  108. <summary>
  109. Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging"/>.
  110. </summary>
  111. <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>.</param>
  112. <returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging"/>, otherwise false.</returns>
  113. </member>
  114. <member name="M:Microsoft.Extensions.Hosting.HostEnvironmentEnvExtensions.IsProduction(Microsoft.Extensions.Hosting.IHostEnvironment)">
  115. <summary>
  116. Checks if the current host environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production"/>.
  117. </summary>
  118. <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>.</param>
  119. <returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production"/>, otherwise false.</returns>
  120. </member>
  121. <member name="M:Microsoft.Extensions.Hosting.HostEnvironmentEnvExtensions.IsEnvironment(Microsoft.Extensions.Hosting.IHostEnvironment,System.String)">
  122. <summary>
  123. Compares the current host environment name against the specified value.
  124. </summary>
  125. <param name="hostEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>.</param>
  126. <param name="environmentName">Environment name to validate against.</param>
  127. <returns>True if the specified name is the same as the current environment, otherwise false.</returns>
  128. </member>
  129. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostBuilderExtensions.Start(Microsoft.Extensions.Hosting.IHostBuilder)">
  130. <summary>
  131. Builds and starts the host.
  132. </summary>
  133. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to start.</param>
  134. <returns>The started <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</returns>
  135. </member>
  136. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostBuilderExtensions.StartAsync(Microsoft.Extensions.Hosting.IHostBuilder,System.Threading.CancellationToken)">
  137. <summary>
  138. Builds and starts the host.
  139. </summary>
  140. <param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to start.</param>
  141. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the start.</param>
  142. <returns>The started <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</returns>
  143. </member>
  144. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Start(Microsoft.Extensions.Hosting.IHost)">
  145. <summary>
  146. Starts the host synchronously.
  147. </summary>
  148. <param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> to start.</param>
  149. </member>
  150. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.StopAsync(Microsoft.Extensions.Hosting.IHost,System.TimeSpan)">
  151. <summary>
  152. Attempts to gracefully stop the host with the given timeout.
  153. </summary>
  154. <param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> to stop.</param>
  155. <param name="timeout">The timeout for stopping gracefully. Once expired the
  156. server may terminate any remaining active connections.</param>
  157. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  158. </member>
  159. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdown(Microsoft.Extensions.Hosting.IHost)">
  160. <summary>
  161. Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM.
  162. </summary>
  163. <param name="host">The running <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</param>
  164. </member>
  165. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(Microsoft.Extensions.Hosting.IHost)">
  166. <summary>
  167. Runs an application and block the calling thread until host shutdown.
  168. </summary>
  169. <param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> to run.</param>
  170. </member>
  171. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(Microsoft.Extensions.Hosting.IHost,System.Threading.CancellationToken)">
  172. <summary>
  173. Runs an application and returns a <see cref="T:System.Threading.Tasks.Task"/> that only completes when the token is triggered or shutdown is triggered.
  174. The <paramref name="host"/> instance is disposed of after running.
  175. </summary>
  176. <param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> to run.</param>
  177. <param name="token">The token to trigger shutdown.</param>
  178. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  179. </member>
  180. <member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdownAsync(Microsoft.Extensions.Hosting.IHost,System.Threading.CancellationToken)">
  181. <summary>
  182. Returns a Task that completes when shutdown is triggered via the given token.
  183. </summary>
  184. <param name="host">The running <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</param>
  185. <param name="token">The token to trigger shutdown.</param>
  186. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  187. </member>
  188. <member name="T:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions">
  189. <summary>
  190. Extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.
  191. </summary>
  192. </member>
  193. <member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsDevelopment(Microsoft.Extensions.Hosting.IHostingEnvironment)">
  194. <summary>
  195. Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development"/>.
  196. </summary>
  197. <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
  198. <returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development"/>, otherwise false.</returns>
  199. </member>
  200. <member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsStaging(Microsoft.Extensions.Hosting.IHostingEnvironment)">
  201. <summary>
  202. Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging"/>.
  203. </summary>
  204. <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
  205. <returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging"/>, otherwise false.</returns>
  206. </member>
  207. <member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsProduction(Microsoft.Extensions.Hosting.IHostingEnvironment)">
  208. <summary>
  209. Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production"/>.
  210. </summary>
  211. <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
  212. <returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production"/>, otherwise false.</returns>
  213. </member>
  214. <member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsEnvironment(Microsoft.Extensions.Hosting.IHostingEnvironment,System.String)">
  215. <summary>
  216. Compares the current hosting environment name against the specified value.
  217. </summary>
  218. <param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
  219. <param name="environmentName">Environment name to validate against.</param>
  220. <returns>True if the specified name is the same as the current environment, otherwise false.</returns>
  221. </member>
  222. <member name="T:Microsoft.Extensions.Hosting.IApplicationLifetime">
  223. <summary>
  224. Allows consumers to perform cleanup during a graceful shutdown.
  225. <para>
  226. This type is obsolete and will be removed in a future version.
  227. The recommended alternative is Microsoft.Extensions.Hosting.IHostApplicationLifetime.
  228. </para>
  229. </summary>
  230. </member>
  231. <member name="P:Microsoft.Extensions.Hosting.IApplicationLifetime.ApplicationStarted">
  232. <summary>
  233. Triggered when the application host has fully started and is about to wait
  234. for a graceful shutdown.
  235. </summary>
  236. </member>
  237. <member name="P:Microsoft.Extensions.Hosting.IApplicationLifetime.ApplicationStopping">
  238. <summary>
  239. Triggered when the application host is performing a graceful shutdown.
  240. Requests may still be in flight. Shutdown will block until this event completes.
  241. </summary>
  242. </member>
  243. <member name="P:Microsoft.Extensions.Hosting.IApplicationLifetime.ApplicationStopped">
  244. <summary>
  245. Triggered when the application host is performing a graceful shutdown.
  246. All requests should be complete at this point. Shutdown will block
  247. until this event completes.
  248. </summary>
  249. </member>
  250. <member name="M:Microsoft.Extensions.Hosting.IApplicationLifetime.StopApplication">
  251. <summary>
  252. Requests termination of the current application.
  253. </summary>
  254. </member>
  255. <member name="T:Microsoft.Extensions.Hosting.IHost">
  256. <summary>
  257. A program abstraction.
  258. </summary>
  259. </member>
  260. <member name="P:Microsoft.Extensions.Hosting.IHost.Services">
  261. <summary>
  262. The programs configured services.
  263. </summary>
  264. </member>
  265. <member name="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)">
  266. <summary>
  267. Start the program.
  268. </summary>
  269. <param name="cancellationToken">Used to abort program start.</param>
  270. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that will be completed when the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> starts.</returns>
  271. </member>
  272. <member name="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)">
  273. <summary>
  274. Attempts to gracefully stop the program.
  275. </summary>
  276. <param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
  277. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that will be completed when the <see cref="T:Microsoft.Extensions.Hosting.IHost"/> stops.</returns>
  278. </member>
  279. <member name="T:Microsoft.Extensions.Hosting.IHostApplicationLifetime">
  280. <summary>
  281. Allows consumers to be notified of application lifetime events. This interface is not intended to be user-replaceable.
  282. </summary>
  283. </member>
  284. <member name="P:Microsoft.Extensions.Hosting.IHostApplicationLifetime.ApplicationStarted">
  285. <summary>
  286. Triggered when the application host has fully started.
  287. </summary>
  288. </member>
  289. <member name="P:Microsoft.Extensions.Hosting.IHostApplicationLifetime.ApplicationStopping">
  290. <summary>
  291. Triggered when the application host is starting a graceful shutdown.
  292. Shutdown will block until all callbacks registered on this token have completed.
  293. </summary>
  294. </member>
  295. <member name="P:Microsoft.Extensions.Hosting.IHostApplicationLifetime.ApplicationStopped">
  296. <summary>
  297. Triggered when the application host has completed a graceful shutdown.
  298. The application will not exit until all callbacks registered on this token have completed.
  299. </summary>
  300. </member>
  301. <member name="M:Microsoft.Extensions.Hosting.IHostApplicationLifetime.StopApplication">
  302. <summary>
  303. Requests termination of the current application.
  304. </summary>
  305. </member>
  306. <member name="T:Microsoft.Extensions.Hosting.IHostBuilder">
  307. <summary>
  308. A program initialization abstraction.
  309. </summary>
  310. </member>
  311. <member name="P:Microsoft.Extensions.Hosting.IHostBuilder.Properties">
  312. <summary>
  313. A central location for sharing state between components during the host building process.
  314. </summary>
  315. </member>
  316. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureHostConfiguration(System.Action{Microsoft.Extensions.Configuration.IConfigurationBuilder})">
  317. <summary>
  318. Set up the configuration for the builder itself. This will be used to initialize the <see cref="T:Microsoft.Extensions.Hosting.IHostEnvironment"/>
  319. for use later in the build process. This can be called multiple times and the results will be additive.
  320. </summary>
  321. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  322. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
  323. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  324. </member>
  325. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureAppConfiguration(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.Configuration.IConfigurationBuilder})">
  326. <summary>
  327. Sets up the configuration for the remainder of the build process and application. This can be called multiple times and
  328. the results will be additive. The results will be available at <see cref="P:Microsoft.Extensions.Hosting.HostBuilderContext.Configuration"/> for
  329. subsequent operations, as well as in <see cref="P:Microsoft.Extensions.Hosting.IHost.Services"/>.
  330. </summary>
  331. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
  332. to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the application.</param>
  333. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  334. </member>
  335. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})">
  336. <summary>
  337. Adds services to the container. This can be called multiple times and the results will be additive.
  338. </summary>
  339. <param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> that will be used
  340. to construct the <see cref="T:System.IServiceProvider"/>.</param>
  341. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  342. </member>
  343. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.UseServiceProviderFactory``1(Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0})">
  344. <summary>
  345. Overrides the factory used to create the service provider.
  346. </summary>
  347. <typeparam name="TContainerBuilder">The type of builder.</typeparam>
  348. <param name="factory">The factory to register.</param>
  349. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  350. </member>
  351. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.UseServiceProviderFactory``1(System.Func{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0}})">
  352. <summary>
  353. Overrides the factory used to create the service provider.
  354. </summary>
  355. <typeparam name="TContainerBuilder">The type of builder.</typeparam>
  356. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  357. </member>
  358. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureContainer``1(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,``0})">
  359. <summary>
  360. Enables configuring the instantiated dependency container. This can be called multiple times and
  361. the results will be additive.
  362. </summary>
  363. <typeparam name="TContainerBuilder">The type of builder.</typeparam>
  364. <param name="configureDelegate">The delegate which configures the builder.</param>
  365. <returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
  366. </member>
  367. <member name="M:Microsoft.Extensions.Hosting.IHostBuilder.Build">
  368. <summary>
  369. Run the given actions to initialize the host. This can only be called once.
  370. </summary>
  371. <returns>An initialized <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</returns>
  372. </member>
  373. <member name="T:Microsoft.Extensions.Hosting.IHostedService">
  374. <summary>
  375. Defines methods for objects that are managed by the host.
  376. </summary>
  377. </member>
  378. <member name="M:Microsoft.Extensions.Hosting.IHostedService.StartAsync(System.Threading.CancellationToken)">
  379. <summary>
  380. Triggered when the application host is ready to start the service.
  381. </summary>
  382. <param name="cancellationToken">Indicates that the start process has been aborted.</param>
  383. </member>
  384. <member name="M:Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken)">
  385. <summary>
  386. Triggered when the application host is performing a graceful shutdown.
  387. </summary>
  388. <param name="cancellationToken">Indicates that the shutdown process should no longer be graceful.</param>
  389. </member>
  390. <member name="T:Microsoft.Extensions.Hosting.IHostEnvironment">
  391. <summary>
  392. Provides information about the hosting environment an application is running in.
  393. </summary>
  394. </member>
  395. <member name="P:Microsoft.Extensions.Hosting.IHostEnvironment.EnvironmentName">
  396. <summary>
  397. Gets or sets the name of the environment. The host automatically sets this property to the value of the
  398. "environment" key as specified in configuration.
  399. </summary>
  400. </member>
  401. <member name="P:Microsoft.Extensions.Hosting.IHostEnvironment.ApplicationName">
  402. <summary>
  403. Gets or sets the name of the application. This property is automatically set by the host to the assembly containing
  404. the application entry point.
  405. </summary>
  406. </member>
  407. <member name="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootPath">
  408. <summary>
  409. Gets or sets the absolute path to the directory that contains the application content files.
  410. </summary>
  411. </member>
  412. <member name="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootFileProvider">
  413. <summary>
  414. Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.Extensions.Hosting.IHostEnvironment.ContentRootPath"/>.
  415. </summary>
  416. </member>
  417. <member name="T:Microsoft.Extensions.Hosting.IHostingEnvironment">
  418. <summary>
  419. Provides information about the hosting environment an application is running in.
  420. <para>
  421. This type is obsolete and will be removed in a future version.
  422. The recommended alternative is Microsoft.Extensions.Hosting.IHostEnvironment.
  423. </para>
  424. </summary>
  425. </member>
  426. <member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.EnvironmentName">
  427. <summary>
  428. Gets or sets the name of the environment. The host automatically sets this property to the value of the
  429. of the "environment" key as specified in configuration.
  430. </summary>
  431. </member>
  432. <member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ApplicationName">
  433. <summary>
  434. Gets or sets the name of the application. This property is automatically set by the host to the assembly containing
  435. the application entry point.
  436. </summary>
  437. </member>
  438. <member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath">
  439. <summary>
  440. Gets or sets the absolute path to the directory that contains the application content files.
  441. </summary>
  442. </member>
  443. <member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootFileProvider">
  444. <summary>
  445. Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath"/>.
  446. </summary>
  447. </member>
  448. <member name="M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken)">
  449. <summary>
  450. Called at the start of <see cref="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)"/> which will wait until it's complete before
  451. continuing. This can be used to delay startup until signaled by an external event.
  452. </summary>
  453. <param name="cancellationToken">Used to abort program start.</param>
  454. <returns>A <see cref="T:System.Threading.Tasks.Task"/>.</returns>
  455. </member>
  456. <member name="M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken)">
  457. <summary>
  458. Called from <see cref="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)"/> to indicate that the host is stopping and it's time to shut down.
  459. </summary>
  460. <param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
  461. <returns>A <see cref="T:System.Threading.Tasks.Task"/>.</returns>
  462. </member>
  463. <member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollectionHostedServiceExtensions.AddHostedService``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  464. <summary>
  465. Add an <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> registration for the given type.
  466. </summary>
  467. <typeparam name="THostedService">An <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> to register.</typeparam>
  468. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to register with.</param>
  469. <returns>The original <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</returns>
  470. </member>
  471. <member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollectionHostedServiceExtensions.AddHostedService``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Func{System.IServiceProvider,``0})">
  472. <summary>
  473. Add an <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> registration for the given type.
  474. </summary>
  475. <typeparam name="THostedService">An <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> to register.</typeparam>
  476. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to register with.</param>
  477. <param name="implementationFactory">A factory to create new instances of the service implementation.</param>
  478. <returns>The original <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</returns>
  479. </member>
  480. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
  481. <summary>
  482. Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
  483. for example through <see cref="N:System.Reflection"/>.
  484. </summary>
  485. <remarks>
  486. This allows tools to understand which members are being accessed during the execution
  487. of a program.
  488. This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
  489. When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
  490. that the string represents a fully qualified type name.
  491. When this attribute is applied to a class, interface, or struct, the members specified
  492. can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
  493. <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
  494. If the attribute is applied to a method it's treated as a special case and it implies
  495. the attribute should be applied to the "this" parameter of the method. As such the attribute
  496. should only be used on instance methods of types assignable to System.Type (or string, but no methods
  497. will use it there).
  498. </remarks>
  499. </member>
  500. <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
  501. <summary>
  502. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
  503. with the specified member types.
  504. </summary>
  505. <param name="memberTypes">The types of members dynamically accessed.</param>
  506. </member>
  507. <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
  508. <summary>
  509. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  510. of members dynamically accessed.
  511. </summary>
  512. </member>
  513. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  514. <summary>
  515. Specifies the types of members that are dynamically accessed.
  516. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  517. bitwise combination of its member values.
  518. </summary>
  519. </member>
  520. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  521. <summary>
  522. Specifies no members.
  523. </summary>
  524. </member>
  525. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  526. <summary>
  527. Specifies the default, parameterless public constructor.
  528. </summary>
  529. </member>
  530. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  531. <summary>
  532. Specifies all public constructors.
  533. </summary>
  534. </member>
  535. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  536. <summary>
  537. Specifies all non-public constructors.
  538. </summary>
  539. </member>
  540. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  541. <summary>
  542. Specifies all public methods.
  543. </summary>
  544. </member>
  545. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  546. <summary>
  547. Specifies all non-public methods.
  548. </summary>
  549. </member>
  550. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  551. <summary>
  552. Specifies all public fields.
  553. </summary>
  554. </member>
  555. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  556. <summary>
  557. Specifies all non-public fields.
  558. </summary>
  559. </member>
  560. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  561. <summary>
  562. Specifies all public nested types.
  563. </summary>
  564. </member>
  565. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  566. <summary>
  567. Specifies all non-public nested types.
  568. </summary>
  569. </member>
  570. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  571. <summary>
  572. Specifies all public properties.
  573. </summary>
  574. </member>
  575. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  576. <summary>
  577. Specifies all non-public properties.
  578. </summary>
  579. </member>
  580. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  581. <summary>
  582. Specifies all public events.
  583. </summary>
  584. </member>
  585. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  586. <summary>
  587. Specifies all non-public events.
  588. </summary>
  589. </member>
  590. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  591. <summary>
  592. Specifies all interfaces implemented by the type.
  593. </summary>
  594. </member>
  595. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  596. <summary>
  597. Specifies all members.
  598. </summary>
  599. </member>
  600. </members>
  601. </doc>