Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientHttp2Session

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

Optional alpnProtocol

alpnProtocol: string

closed

closed: boolean

connecting

connecting: boolean

destroyed

destroyed: boolean

Optional encrypted

encrypted: boolean

localSettings

localSettings: Settings

Optional originSet

originSet: string[]

pendingSettingsAck

pendingSettingsAck: boolean

remoteSettings

remoteSettings: Settings

socket

socket: Socket | TLSSocket

state

state: SessionState

type

type: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

close

  • close(callback?: function): void

  • Parameters

    • Optional callback: function
        • (): void

        • Returns void

    Returns void

destroy

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

  • Parameters

    • Optional error: Error
    • Optional code: number

    Returns void

emit

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

goaway

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

  • Parameters

    • Optional code: number
    • Optional lastStreamID: number
    • Optional opaqueData: Buffer | DataView | NodeJS.TypedArray

    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[]

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

  • Parameters

    • event: "altsvc"
    • listener: function
        • (alt: string, origin: string, stream: number): void

        • Parameters

          • alt: string
          • origin: string
          • stream: number

          Returns void

    Returns this

  • Parameters

    • event: "origin"
    • listener: function
        • (origins: string[]): void

        • Parameters

          • origins: string[]

          Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

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

ping

  • ping(callback: function): boolean
  • ping(payload: Buffer | DataView | NodeJS.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 | NodeJS.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: "altsvc", listener: function): this
  • prependListener(event: "origin", listener: function): this
  • prependListener(event: "connect", listener: function): this
  • prependListener(event: "stream", listener: function): this
  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: "altsvc", listener: function): this
  • prependOnceListener(event: "origin", listener: function): this
  • 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[]

  • Parameters

    • event: string | symbol

    Returns Function[]

ref

  • ref(): void

  • 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
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

request

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setTimeout

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

  • Parameters

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

        • Returns void

    Returns void

settings

unref

  • unref(): void

  • Returns void

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