Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPServer

表示一个 HTTP 服务器（支持 HTTPS、HTTP/2）

Hierarchy

  • Http2SecureServer
    • HTTPServer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • 初始化新的服务器

    Parameters

    Returns HTTPServer

Properties

connections

connections: number

listening

listening: boolean

maxAllowedContentLength

maxAllowedContentLength: number = 20 * 1024 * 1024

获取或设置允许请求的最大字节数

maxConnections

maxConnections: number

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

isSecure

  • get isSecure(): boolean

  • 判断当前服务器是否使用了加密传输协议（HTTPS）

    Returns boolean

sessions

  • 获取或设置当前服务器的会话管理器

    Returns HTTPSessionManager

  • 获取或设置当前服务器的会话管理器

    Parameters

    Returns void

url

  • get url(): string

  • 获取当前服务器的根地址，如果服务器未在监听则返回 undefined

    Returns string

Methods

addContext

  • addContext(hostName: string, credentials: SecureContextOptions): void

  • Parameters

    • hostName: string
    • credentials: SecureContextOptions

    Returns void

addListener

  • addListener(event: "checkContinue", listener: function): this
  • addListener(event: "request", listener: function): this
  • addListener(event: "session", listener: function): this
  • addListener(event: "sessionError", listener: function): this
  • addListener(event: "stream", listener: function): this
  • addListener(event: "timeout", listener: function): this
  • addListener(event: "unknownProtocol", listener: function): this
  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: "checkContinue"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "request"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "session"
    • listener: function
        • (session: ServerHttp2Session): void

        • Parameters

          • session: ServerHttp2Session

          Returns void

    Returns this

  • Parameters

    • event: "sessionError"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "stream"
    • listener: function
        • (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): void

        • Parameters

          • stream: ServerHttp2Stream
          • headers: IncomingHttpHeaders
          • flags: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "unknownProtocol"
    • listener: function
        • (socket: TLSSocket): void

        • Parameters

          • socket: TLSSocket

          Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

address

  • address(): AddressInfo | string | null

  • Returns AddressInfo | string | null

close

  • close(callback?: function): this

  • Parameters

    • Optional callback: function
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns this

emit

  • emit(event: "checkContinue", request: Http2ServerRequest, response: Http2ServerResponse): boolean
  • emit(event: "request", request: Http2ServerRequest, response: Http2ServerResponse): boolean
  • emit(event: "session", session: ServerHttp2Session): boolean
  • emit(event: "sessionError", err: Error): boolean
  • emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean
  • emit(event: "timeout"): boolean
  • emit(event: "unknownProtocol", socket: TLSSocket): boolean
  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: "checkContinue"
    • request: Http2ServerRequest
    • response: Http2ServerResponse

    Returns boolean

  • Parameters

    • event: "request"
    • request: Http2ServerRequest
    • response: Http2ServerResponse

    Returns boolean

  • Parameters

    • event: "session"
    • session: ServerHttp2Session

    Returns boolean

  • Parameters

    • event: "sessionError"
    • err: Error

    Returns boolean

  • Parameters

    • event: "stream"
    • stream: ServerHttp2Stream
    • headers: IncomingHttpHeaders
    • flags: number

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

  • Parameters

    • event: "unknownProtocol"
    • socket: TLSSocket

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getConnections

  • getConnections(cb: function): void

  • Parameters

    • cb: function
        • (error: Error | null, count: number): void

        • Parameters

          • error: Error | null
          • count: number

          Returns void

    Returns void

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Protected handleRequest

  • 处理原生 HTTP 请求事件

    Parameters

    Returns void

listen

  • listen(port?: number, hostname?: string, backlog?: number, listeningListener?: function): this
  • listen(port?: number, hostname?: string, listeningListener?: function): this
  • listen(port?: number, backlog?: number, listeningListener?: function): this
  • listen(port?: number, listeningListener?: function): this
  • listen(path: string, backlog?: number, listeningListener?: function): this
  • listen(path: string, listeningListener?: function): this
  • listen(options: ListenOptions, listeningListener?: function): this
  • listen(handle: any, backlog?: number, listeningListener?: function): this
  • listen(handle: any, listeningListener?: function): this

  • Parameters

    • Optional port: number
    • Optional hostname: string
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • Optional port: number
    • Optional hostname: string
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • Optional port: number
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • Optional port: number
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • path: string
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • path: string
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • options: ListenOptions
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • handle: any
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • handle: any
    • Optional listeningListener: function
        • (): void

        • Returns void

    Returns this

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "checkContinue", listener: function): this
  • on(event: "request", listener: function): this
  • on(event: "session", listener: function): this
  • on(event: "sessionError", listener: function): this
  • on(event: "stream", listener: function): this
  • on(event: "timeout", listener: function): this
  • on(event: "unknownProtocol", listener: function): this
  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: "checkContinue"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "request"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "session"
    • listener: function
        • (session: ServerHttp2Session): void

        • Parameters

          • session: ServerHttp2Session

          Returns void

    Returns this

  • Parameters

    • event: "sessionError"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "stream"
    • listener: function
        • (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): void

        • Parameters

          • stream: ServerHttp2Stream
          • headers: IncomingHttpHeaders
          • flags: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "unknownProtocol"
    • listener: function
        • (socket: TLSSocket): void

        • Parameters

          • socket: TLSSocket

          Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: "checkContinue", listener: function): this
  • once(event: "request", listener: function): this
  • once(event: "session", listener: function): this
  • once(event: "sessionError", listener: function): this
  • once(event: "stream", listener: function): this
  • once(event: "timeout", listener: function): this
  • once(event: "unknownProtocol", listener: function): this
  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: "checkContinue"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "request"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "session"
    • listener: function
        • (session: ServerHttp2Session): void

        • Parameters

          • session: ServerHttp2Session

          Returns void

    Returns this

  • Parameters

    • event: "sessionError"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "stream"
    • listener: function
        • (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): void

        • Parameters

          • stream: ServerHttp2Stream
          • headers: IncomingHttpHeaders
          • flags: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "unknownProtocol"
    • listener: function
        • (socket: TLSSocket): void

        • Parameters

          • socket: TLSSocket

          Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: "checkContinue", listener: function): this
  • prependListener(event: "request", listener: function): this
  • prependListener(event: "session", listener: function): this
  • prependListener(event: "sessionError", listener: function): this
  • prependListener(event: "stream", listener: function): this
  • prependListener(event: "timeout", listener: function): this
  • prependListener(event: "unknownProtocol", listener: function): this
  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: "checkContinue"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "request"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "session"
    • listener: function
        • (session: ServerHttp2Session): void

        • Parameters

          • session: ServerHttp2Session

          Returns void

    Returns this

  • Parameters

    • event: "sessionError"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "stream"
    • listener: function
        • (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): void

        • Parameters

          • stream: ServerHttp2Stream
          • headers: IncomingHttpHeaders
          • flags: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "unknownProtocol"
    • listener: function
        • (socket: TLSSocket): void

        • Parameters

          • socket: TLSSocket

          Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: "checkContinue", listener: function): this
  • prependOnceListener(event: "request", listener: function): this
  • prependOnceListener(event: "session", listener: function): this
  • prependOnceListener(event: "sessionError", listener: function): this
  • prependOnceListener(event: "stream", listener: function): this
  • prependOnceListener(event: "timeout", listener: function): this
  • prependOnceListener(event: "unknownProtocol", listener: function): this
  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: "checkContinue"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "request"
    • listener: function
        • (request: Http2ServerRequest, response: Http2ServerResponse): void

        • Parameters

          • request: Http2ServerRequest
          • response: Http2ServerResponse

          Returns void

    Returns this

  • Parameters

    • event: "session"
    • listener: function
        • (session: ServerHttp2Session): void

        • Parameters

          • session: ServerHttp2Session

          Returns void

    Returns this

  • Parameters

    • event: "sessionError"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "stream"
    • listener: function
        • (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): void

        • Parameters

          • stream: ServerHttp2Stream
          • headers: IncomingHttpHeaders
          • flags: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "unknownProtocol"
    • listener: function
        • (socket: TLSSocket): void

        • Parameters

          • socket: TLSSocket

          Returns void

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

processRequest

  • 处理 HTTP 请求

    Parameters

    Returns void

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

ref

  • ref(): this

  • Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setTimeout

  • setTimeout(msec?: number, callback?: function): this

  • Parameters

    • Optional msec: number
    • Optional callback: function
        • (): void

        • Returns void

    Returns this

unref

  • unref(): this

  • Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc