Class HttpStream

Represents a single http message exchange (request/response) in HTTP/1.1. In H2, it may also represent a PUSH_PROMISE followed by the accompanying response.

NOTE: Binding either the ready or response event will uncork any buffered events and start event delivery

Hierarchy

Implements

Properties

connection

Methods

activate close cork uncork emit

Properties

Readonly connection

connection: HttpConnection

Methods

activate

  • Begin sending the request.

    The stream does nothing until this is called. Call activate() when you are ready for its callbacks and events to fire.

    Returns void

close

  • Closes and ends all communication on this stream. Called automatically after the 'end' event is delivered. Calling this manually is only necessary if you wish to terminate communication mid-request/response.

    Returns void

cork

  • Forces all written events to be buffered in memory. The buffered data will be flushed when uncork is called.

    Returns void

uncork

  • Flushes all data buffered since cork was called.

    NOTE: It is HIGHLY recommended that uncorking should always be done via process.nextTick, not during the EventEmitter.on() call.

    Returns void

emit

  • Synchronously calls each of the listeners registered for the event key supplied in registration order. If the BufferedEventEmitter is currently corked, the event will be buffered until uncork is called.

    Parameters

    • event: EventKey

      The name of the event

    • Rest ...args: any[]

      Event payload

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc