class WebHost
cangjie
public class WebHost <: EndpointRouteBuilder & Resource功能:表示一个可启动和关闭的 Web 主机实例。
父类型:
- EndpointRouteBuilder
Resource
成员概览
| 成员 | 功能 |
|---|---|
| prop logger | 返回当前主机使用的日志记录器。 |
| prop lifetime | 返回当前主机的应用生命周期控制器。 |
| prop environment | 返回当前主机的环境信息。 |
| prop configuration | 返回当前主机的配置对象。 |
| func run() | 运行主机并阻塞直到应用关闭。 |
| func run(String) | 以指定地址运行主机并阻塞直到应用关闭。 |
| func start() | 启动托管服务和 HTTP 服务器。 |
| func waitForShutdown() | 阻塞等待关闭信号并执行关闭流程。 |
| func stop() | 有序停止主机并通知生命周期结束。 |
| func close() | 释放主机持有的资源。 |
| func isClosed() | 检查当前主机是否已关闭。 |
| func createBuilder(Array<String>) | 创建一个预置默认环境、配置和日志的主机构建器。 |
prop logger
cangjie
public prop logger: ILogger功能:返回当前主机使用的日志记录器。
类型:ILogger
prop lifetime
cangjie
public prop lifetime: IHostApplicationLifetime功能:返回当前主机的应用生命周期控制器。
prop environment
cangjie
public prop environment: IHostEnvironment功能:返回当前主机的环境信息。
prop configuration
cangjie
public prop configuration: IConfiguration功能:返回当前主机的配置对象。
func run()
cangjie
public func run(): Unit功能:运行主机并阻塞直到应用关闭。
返回值:
Unit
func run(String)
cangjie
public func run(urls: String): Unit功能:以指定地址运行主机并阻塞直到应用关闭。
参数:
- urls:
String- 要写入配置的监听地址。
返回值:
Unit
func start()
cangjie
public func start(): Unit功能:启动托管服务和 HTTP 服务器。
返回值:
Unit
func waitForShutdown()
cangjie
public func waitForShutdown(): Unit功能:阻塞等待关闭信号并执行关闭流程。
返回值:
Unit
func stop()
cangjie
public func stop(): Unit功能:有序停止主机并通知生命周期结束。
返回值:
Unit
func close()
cangjie
public func close(): Unit功能:释放主机持有的资源。
返回值:
Unit
func isClosed()
cangjie
public func isClosed(): Bool功能:检查当前主机是否已关闭。
返回值:
Bool- 如果主机已关闭则返回 true,否则返回 false。
func createBuilder(Array<String>)
cangjie
public static func createBuilder(args: Array<String>): WebHostBuilder功能:创建一个预置默认环境、配置和日志的主机构建器。
参数:
- args:
Array<String>- 启动时使用的命令行参数。
返回值:
- WebHostBuilder - 返回创建完成的主机构建器。