Class HttpClientConnection

Represents an HTTP connection from a client to a server

Hierarchy

BufferedEventEmitter
- HttpClientConnection

Index

Constructors

Properties

Methods

close cork emit on request uncork

Events

CLOSE CONNECT ERROR

Constructors

constructor

new HttpClientConnection(bootstrap, host_name, port, socketOptions?, tlsOptions?, proxyOptions?): HttpClientConnection
Http connection constructor, signature synced to native version for compatibility
Parameters
- bootstrap: undefined | ClientBootstrap
  
  (native only) leave undefined
- host_name: string
  
  endpoint to connection with
- port: number
  
  port to connect to
- Optional socketOptions: SocketOptions
  
  (native only) leave undefined
- Optional tlsOptions: TlsConnectionOptions
  
  instantiate for TLS, but actual value is unused in browse implementation
- Optional proxyOptions: HttpProxyOptions
  
  options to control proxy usage when establishing the connection
Returns HttpClientConnection

Overrides BufferedEventEmitter.constructor

Properties

_axios

_axios: any

Methods

close

close(): void
Ends the connection

Returns void

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 BufferedEventEmitter.cork

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 BufferedEventEmitter.emit

on

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

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

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

Overrides BufferedEventEmitter.on

request

request(request): HttpClientStream
Make a client initiated request to this connection.
Parameters
- request: HttpRequest
  
  The HttpRequest to attempt on this connection
Returns HttpClientStream
A new stream that will deliver events for the request

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 BufferedEventEmitter.uncork

Events

`Static` CLOSE

CLOSE: string = 'close'

Emitted when the connection has completed

`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

Generated using TypeDoc