Class HttpConnection

Base class for HTTP connections

Hierarchy

__class<typeof BufferedEventEmitter, this> & BufferedEventEmitter<this>
- HttpConnection
  - HttpClientConnection

Implements

ResourceSafe

Index

Methods

close on cork uncork emit

Events

CONNECT ERROR CLOSE

Methods

close

close(): void
Close the connection. Shutdown is asynchronous. This call has no effect if the connection is already closing.

Returns void

Implementation of ResourceSafe.close

on

on(event, listener): HttpConnection
Parameters
- event: "connect"
- listener: HttpClientConnectionConnected
Returns HttpConnection

Overrides NativeResourceMixin(BufferedEventEmitter).on
on(event, listener): HttpConnection
Parameters
- event: "error"
- listener: HttpClientConnectionError
Returns HttpConnection

Overrides NativeResourceMixin(BufferedEventEmitter).on
on(event, listener): HttpConnection
Parameters
- event: "close"
- listener: HttpClientConnectionClosed
Returns HttpConnection

Overrides NativeResourceMixin(BufferedEventEmitter).on

cork

cork(): void
Forces all written events to be buffered in memory. The buffered data will be flushed when uncork is called.

Returns void

Inherited from NativeResourceMixin(BufferedEventEmitter).cork

uncork

uncork(): void
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

Inherited from NativeResourceMixin(BufferedEventEmitter).uncork

emit

emit(event, ...args): boolean
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

Inherited from NativeResourceMixin(BufferedEventEmitter).emit

Events

`Static` CONNECT

CONNECT: string = 'connect'

Emitted when the connection is connected and ready to start streams

`Static` ERROR

ERROR: string = 'error'

Emitted when an error occurs on the connection

`Static` CLOSE

CLOSE: string = 'close'

Emitted when the connection has completed

Generated using TypeDoc