Class HttpServer

Http服务器对象

Hierarchy

HttpServer

Index

Constructors

constructor

new HttpServer(options?: {
ctrlPort?: number;
stackSize?: number;
}): HttpServer
Parameters
- Optional options: {
  ctrlPort?: number;
  stackSize?: number;
  }
  - Optional ctrlPort?: number
  - Optional stackSize?: number
Returns HttpServer

Properties

ctrlPort

ctrlPort: number

此服务器的控制端口

`Readonly` running

running: boolean

服务器是否正在运行?

Methods

delete

delete(path: string, handler: HttpdHandlerCallback): HttpServer
添加HTTP DELEET方法路由入口
Parameters
- path: string
  
  路径，支持 * 通配符。
- handler: HttpdHandlerCallback
  
  服务处理函数
Returns HttpServer

get

get(path: string, handler: HttpdHandlerCallback): HttpServer
添加HTTP GET方法路由入口
Parameters
- path: string
  
  路径，支持 * 通配符。
- handler: HttpdHandlerCallback
  
  处理函数，可以异步函数。
Returns HttpServer

head

head(path: string, handler: HttpdHandlerCallback): HttpServer
添加HTTP HEAD方法路由入口
Parameters
- path: string
  
  路径，支持 * 通配符。
- handler: HttpdHandlerCallback
  
  服务处理函数
Returns HttpServer

listen

listen(port: number): HttpServer
监听指定端口，运行http服务器
Parameters
- port: number
Returns HttpServer

post

post(path: string, handler: HttpdHandlerCallback): HttpServer
添加HTTP POST方法路由入口
Parameters
- path: string
  
  路径，支持 * 通配符。
- handler: HttpdHandlerCallback
  
  服务处理函数
Returns HttpServer

put

put(path: string, handler: HttpdHandlerCallback): HttpServer
添加HTTP PUT方法路由入口
Parameters
- path: string
  
  路径，支持 * 通配符。
- handler: HttpdHandlerCallback
  
  服务处理函数
Returns HttpServer

stop

stop(): Promise<HttpServer>
停止http服务器

Returns Promise<HttpServer>

ws

ws(path: string, options: {
    onConnect?: ((conn: HttpServerWsConnection) => void);
    onDisconnect?: ((conn: HttpServerWsConnection) => void);
    onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void);
}): HttpServer
添加 Websocket 路由入口
Parameters
- path: string
  
  路径，支持 * 通配符。
- options: {
      onConnect?: ((conn: HttpServerWsConnection) => void);
      onDisconnect?: ((conn: HttpServerWsConnection) => void);
      onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void);
  }
  - Optional onConnect?: ((conn: HttpServerWsConnection) => void)
    - (conn: HttpServerWsConnection): void
      
      有客户端连接时的回调函数
      
      Parameters
      
      conn: HttpServerWsConnection
      
      Returns void
  - Optional onDisconnect?: ((conn: HttpServerWsConnection) => void)
    - (conn: HttpServerWsConnection): void
      
      客户端断开连接的回调函数
      
      Parameters
      
      conn: HttpServerWsConnection
      
      Returns void
  - Optional onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void)
    - (conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean): void
      
      收到客户端数据的回调函数
      
      Parameters
      
      conn: HttpServerWsConnection
      
      data: String | ArrayBuffer
      
      final: boolean
      
      Returns void
Returns HttpServer

Class HttpServer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: { ctrlPort?: number; stackSize?: number; }

Optional ctrlPort?: number

Optional stackSize?: number

Returns HttpServer

Properties

ctrlPort

Readonly running

Methods

delete

Parameters

path: string

handler: HttpdHandlerCallback

Returns HttpServer

get

Parameters

path: string

handler: HttpdHandlerCallback

Returns HttpServer

head

Parameters

path: string

handler: HttpdHandlerCallback

Returns HttpServer

listen

Parameters

port: number

Returns HttpServer

post

Parameters

path: string

handler: HttpdHandlerCallback

Returns HttpServer

put

Parameters

path: string

handler: HttpdHandlerCallback

Returns HttpServer

stop

Returns Promise<HttpServer>

ws

Parameters

path: string

options: { onConnect?: ((conn: HttpServerWsConnection) => void); onDisconnect?: ((conn: HttpServerWsConnection) => void); onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void); }

Optional onConnect?: ((conn: HttpServerWsConnection) => void)

Parameters

conn: HttpServerWsConnection

Returns void

Optional onDisconnect?: ((conn: HttpServerWsConnection) => void)

Parameters

conn: HttpServerWsConnection

Returns void

Optional onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void)

Parameters

conn: HttpServerWsConnection

data: String | ArrayBuffer

final: boolean

Returns void

Returns HttpServer

Settings

Member Visibility

Theme

`Optional` options: {
ctrlPort?: number;
stackSize?: number;
}

`Optional` ctrlPort?: number

`Optional` stackSize?: number

`Readonly` running

options: {
onConnect?: ((conn: HttpServerWsConnection) => void);
onDisconnect?: ((conn: HttpServerWsConnection) => void);
onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void);
}

`Optional` onConnect?: ((conn: HttpServerWsConnection) => void)

`Optional` onDisconnect?: ((conn: HttpServerWsConnection) => void)

`Optional` onMessage?: ((conn: HttpServerWsConnection, data: String | ArrayBuffer, final: boolean) => void)