Http2Session | typescript

Hierarchy

EventEmitter
- Http2Session
  - ClientHttp2Session
  - ServerHttp2Session

Index

Constructors

constructor

Properties

Constructors

constructor

new Http2Session(options?: EventEmitterOptions): Http2Session

Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- Optional options: EventEmitterOptions
Returns Http2Session

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 captureRejectionSymbol

captureRejectionSymbol: keyof symbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static errorMonitor

errorMonitor: keyof symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: "close", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "frameError", listener: function): this
addListener(event: "goaway", listener: function): this
addListener(event: "localSettings", listener: function): this
addListener(event: "ping", listener: function): this
addListener(event: "remoteSettings", listener: function): this
addListener(event: "timeout", listener: function): this
addListener(event: string | symbol, listener: function): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:298
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:299
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:300
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number, streamID: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      - streamID: number
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:301
Parameters
- event: "goaway"
- listener: function
  - - (errorCode: number, lastStreamID: number, opaqueData: Buffer): void
    - Parameters
      - errorCode: number
      - lastStreamID: number
      - opaqueData: Buffer
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:302
Parameters
- event: "localSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:303
Parameters
- event: "ping"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:304
Parameters
- event: "remoteSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:305
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/http2.d.ts:306
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(callback?: function): void

- Defined in node_modules/@types/node/http2.d.ts:287
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void

destroy

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

- Defined in node_modules/@types/node/http2.d.ts:288
Parameters
- Optional error: Error
- Optional code: number
Returns void

emit

emit(event: "close"): boolean
emit(event: "error", err: Error): boolean
emit(event: "frameError", frameType: number, errorCode: number, streamID: number): boolean
emit(event: "goaway", errorCode: number, lastStreamID: number, opaqueData: Buffer): boolean
emit(event: "localSettings", settings: Settings): boolean
emit(event: "ping"): boolean
emit(event: "remoteSettings", settings: Settings): boolean
emit(event: "timeout"): boolean
emit(event: string | symbol, ...args: any[]): boolean

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:308
Parameters
- event: "close"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:309
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:310
Parameters
- event: "frameError"
- frameType: number
- errorCode: number
- streamID: number
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:311
Parameters
- event: "goaway"
- errorCode: number
- lastStreamID: number
- opaqueData: Buffer
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:312
Parameters
- event: "localSettings"
- settings: Settings
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:313
Parameters
- event: "ping"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:314
Parameters
- event: "remoteSettings"
- settings: Settings
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:315
Parameters
- event: "timeout"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/http2.d.ts:316
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

goaway

goaway(code?: number, lastStreamID?: number, opaqueData?: ArrayBufferView): void

- Defined in node_modules/@types/node/http2.d.ts:289
Parameters
- Optional code: number
- Optional lastStreamID: number
- Optional opaqueData: ArrayBufferView
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "close", listener: function): this
on(event: "error", listener: function): this
on(event: "frameError", listener: function): this
on(event: "goaway", listener: function): this
on(event: "localSettings", listener: function): this
on(event: "ping", listener: function): this
on(event: "remoteSettings", listener: function): this
on(event: "timeout", listener: function): this
on(event: string | symbol, listener: function): this

Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:318
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:319
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:320
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number, streamID: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      - streamID: number
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:321
Parameters
- event: "goaway"
- listener: function
  - - (errorCode: number, lastStreamID: number, opaqueData: Buffer): void
    - Parameters
      - errorCode: number
      - lastStreamID: number
      - opaqueData: Buffer
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:322
Parameters
- event: "localSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:323
Parameters
- event: "ping"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:324
Parameters
- event: "remoteSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:325
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/http2.d.ts:326
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "close", listener: function): this
once(event: "error", listener: function): this
once(event: "frameError", listener: function): this
once(event: "goaway", listener: function): this
once(event: "localSettings", listener: function): this
once(event: "ping", listener: function): this
once(event: "remoteSettings", listener: function): this
once(event: "timeout", listener: function): this
once(event: string | symbol, listener: function): this

Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:328
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:329
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:330
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number, streamID: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      - streamID: number
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:331
Parameters
- event: "goaway"
- listener: function
  - - (errorCode: number, lastStreamID: number, opaqueData: Buffer): void
    - Parameters
      - errorCode: number
      - lastStreamID: number
      - opaqueData: Buffer
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:332
Parameters
- event: "localSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:333
Parameters
- event: "ping"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:334
Parameters
- event: "remoteSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:335
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/http2.d.ts:336
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

ping

ping(callback: function): boolean
ping(payload: ArrayBufferView, callback: function): boolean

- Defined in node_modules/@types/node/http2.d.ts:290
Parameters
- callback: function
  - - (err: Error | null, duration: number, payload: Buffer): void
    - Parameters
      - err: Error | null
      - duration: number
      - payload: Buffer
      Returns void
Returns boolean
- Defined in node_modules/@types/node/http2.d.ts:291
Parameters
- payload: ArrayBufferView
- 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: "close", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "frameError", listener: function): this
prependListener(event: "goaway", listener: function): this
prependListener(event: "localSettings", listener: function): this
prependListener(event: "ping", listener: function): this
prependListener(event: "remoteSettings", listener: function): this
prependListener(event: "timeout", listener: function): this
prependListener(event: string | symbol, listener: function): this

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:338
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:339
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:340
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number, streamID: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      - streamID: number
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:341
Parameters
- event: "goaway"
- listener: function
  - - (errorCode: number, lastStreamID: number, opaqueData: Buffer): void
    - Parameters
      - errorCode: number
      - lastStreamID: number
      - opaqueData: Buffer
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:342
Parameters
- event: "localSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:343
Parameters
- event: "ping"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:344
Parameters
- event: "remoteSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:345
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/http2.d.ts:346
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "frameError", listener: function): this
prependOnceListener(event: "goaway", listener: function): this
prependOnceListener(event: "localSettings", listener: function): this
prependOnceListener(event: "ping", listener: function): this
prependOnceListener(event: "remoteSettings", listener: function): this
prependOnceListener(event: "timeout", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:348
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:349
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:350
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number, streamID: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      - streamID: number
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:351
Parameters
- event: "goaway"
- listener: function
  - - (errorCode: number, lastStreamID: number, opaqueData: Buffer): void
    - Parameters
      - errorCode: number
      - lastStreamID: number
      - opaqueData: Buffer
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:352
Parameters
- event: "localSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:353
Parameters
- event: "ping"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:354
Parameters
- event: "remoteSettings"
- listener: function
  - - (settings: Settings): void
    - Parameters
      - settings: Settings
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:355
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:356
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

ref

ref(): void

- Defined in node_modules/@types/node/http2.d.ts:292
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setLocalWindowSize

setLocalWindowSize(windowSize: number): void

- Defined in node_modules/@types/node/http2.d.ts:293
Parameters
- windowSize: number
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

setTimeout

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

- Defined in node_modules/@types/node/http2.d.ts:294
Parameters
- msecs: number
- Optional callback: function
  - - (): void
    - Returns void
Returns void

settings

settings(settings: Settings): void

- Defined in node_modules/@types/node/http2.d.ts:295
Parameters
- settings: Settings
Returns void

unref

unref(): void

- Defined in node_modules/@types/node/http2.d.ts:296
Returns void

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns Http2Session

Properties

Optional alpnProtocol

closed

connecting

destroyed

Optional encrypted

localSettings

Optional originSet

pendingSettingsAck

remoteSettings

socket

state

type

Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static errorMonitor

Methods

addListener

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "frameError"

listener: function

Parameters

frameType: number

errorCode: number

streamID: number

Returns void

Returns this

Parameters

event: "goaway"

listener: function

Parameters

errorCode: number

lastStreamID: number

opaqueData: Buffer

Returns void

Returns this

Parameters

event: "localSettings"

listener: function

Parameters

settings: Settings

Returns void

Returns this

Parameters

event: "ping"

listener: function

Returns void

Returns this

Parameters

event: "remoteSettings"

listener: function

Parameters

settings: Settings

Returns void

Returns this

Parameters

event: "timeout"