Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerHttp2Session

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

Optional alpnProtocol

alpnProtocol: undefined | string

closed

closed: boolean

connecting

connecting: boolean

destroyed

destroyed: boolean

Optional encrypted

encrypted: undefined | false | true

localSettings

localSettings: Settings

Optional originSet

originSet: string[]

pendingSettingsAck

pendingSettingsAck: boolean

remoteSettings

remoteSettings: Settings

server

server: Http2Server | Http2SecureServer

socket

socket: Socket | TLSSocket

state

state: SessionState

type

type: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: "connect", listener: function): this
  • addListener(event: "stream", listener: function): this
  • addListener(event: string | symbol, listener: function): this

altsvc

  • Parameters

    Returns void

close

  • close(callback?: undefined | function): void

  • Parameters

    • Optional callback: undefined | function

    Returns void

destroy

  • destroy(error?: Error, code?: undefined | number): void

  • Parameters

    • Optional error: Error
    • Optional code: undefined | number

    Returns void

emit

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

goaway

  • goaway(code?: undefined | number, lastStreamID?: undefined | number, opaqueData?: Buffer | DataView | TypedArray): void

  • Parameters

    • Optional code: undefined | number
    • Optional lastStreamID: undefined | number
    • Optional opaqueData: Buffer | DataView | TypedArray

    Returns void

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): 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: "connect", listener: function): this
  • on(event: "stream", listener: function): this
  • on(event: string | symbol, listener: function): this

once

  • once(event: "connect", listener: function): this
  • once(event: "stream", listener: function): this
  • once(event: string | symbol, listener: function): this

origin

  • origin(...args: Array<string | URL | object>): void

  • Parameters

    • Rest ...args: Array<string | URL | object>

    Returns void

ping

  • ping(callback: function): boolean
  • ping(payload: Buffer | DataView | TypedArray, callback: function): boolean

  • Parameters

    • callback: function
        • (err: Error | null, duration: number, payload: Buffer): void

        • Parameters

          • err: Error | null
          • duration: number
          • payload: Buffer

          Returns void

    Returns boolean

  • Parameters

    • payload: Buffer | DataView | TypedArray
    • callback: function
        • (err: Error | null, duration: number, payload: Buffer): void

        • Parameters

          • err: Error | null
          • duration: number
          • payload: Buffer

          Returns void

    Returns boolean

prependListener

  • prependListener(event: "connect", listener: function): this
  • prependListener(event: "stream", listener: function): this
  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: "connect", listener: function): this
  • prependOnceListener(event: "stream", listener: function): this
  • prependOnceListener(event: string | symbol, listener: function): this

rawListeners

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

ref

  • ref(): void

  • Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol): 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

setTimeout

  • setTimeout(msecs: number, callback?: undefined | function): void

  • Parameters

    • msecs: number
    • Optional callback: undefined | function

    Returns void

settings

unref

  • unref(): void

  • Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc