Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpServer

表示一个 Http 服务器。

Hierarchy

  • EventEmitter

Index

Properties

Accessors

Methods

Properties

virtualPath

virtualPath: string = "/"

当前服务器的虚拟路径。

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

connectionCount

  • get connectionCount(): number

isListening

  • get isListening(): boolean

timeout

  • get timeout(): number
  • set timeout(value: number): void

url

  • get url(): string

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

close

  • close(callback?: function): void

  • 关闭当前服务器。

    Parameters

    • Optional callback: function

      关闭的回调函数。

        • (): void

        • Returns void

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listen

  • listen(url?: string, callback?: function): void

  • 监听指定的地址。

    Parameters

    • Default value url: string = "http://0.0.0.0:0/"

      要监听的地址。

    • Optional callback: function

      启动完成的回调函数。

        • (): void

        • Returns void

    Returns void

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected onError

  • onError(e: ErrnoException): void

Protected onStart

  • onStart(): void

Protected onStop

  • onStop(): void

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected processRequest

  • processRequest(req: IncomingMessage, res: ServerResponse): void

  • 当被子类重写时负责处理所有请求。

    Parameters

    • req: IncomingMessage

      当前的请求对象。

    • res: ServerResponse

      当前的响应对象。

    Returns void

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

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(event: "start", listener: function): this
  • on(event: "stop", listener: function): this
  • on(event: "request", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: string | symbol, listener: Function): this

  • 绑定一个服务器启动事件。

    Parameters

    • event: "start"

      要绑定的事件名。

    • listener: function

      要绑定的事件监听器。

        • (): void

        • Returns void

    Returns this

  • 绑定一个服务器停止事件。

    Parameters

    • event: "stop"

      要绑定的事件名。

    • listener: function

      要绑定的事件监听器。

        • (): void

        • Returns void

    Returns this

  • 绑定一个请求事件。

    Parameters

    • event: "request"

      要绑定的事件名。

    • listener: function

      要绑定的事件监听器。

      • @param req 当前的请求对象。
      • @param res 当前的响应对象。
        • (req: IncomingMessage, res: ServerResponse): void

        • Parameters

          • req: IncomingMessage
          • res: ServerResponse

          Returns void

    Returns this

  • 绑定一个错误事件。

    Parameters

    • event: "error"

      要绑定的事件名。

    • listener: function

      要绑定的事件监听器。

      • @param error 相关的错误对象。
        • (error: ErrnoException): void

        • Parameters

          • error: ErrnoException

          Returns void

    Returns this

  • 绑定一个事件。

    Parameters

    • event: string | symbol

      要绑定的事件名。

    • listener: Function

      要绑定的事件监听器。

    Returns this

Generated using TypeDoc