HttpConnection | @vertx/core

Represents an HTTP connection.

HTTP/1.x connection provides an limited implementation, the following methods are implemented:

{@link HttpConnection#close}
{@link HttpConnection#closeHandler}
{@link HttpConnection#exceptionHandler}

Hierarchy

HttpConnection

Methods

close

close(): PromiseLike<void>
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3959
Close the connection and all the currently active streams.

An HTTP/2 connection will send a frame before.

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3966
Close the connection and all the currently active streams.

An HTTP/2 connection will send a frame before.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

closeHandler

closeHandler(handler: ((res: void) => void) | Handler<void>): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3952
Set a close handler. The handler will get notified when the connection is closed.

Parameters
- handler: ((res: void) => void) | Handler<void>
Returns HttpConnection

exceptionHandler

exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable>): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4025
Set an handler called when a connection error happens

Parameters
- handler: ((res: Throwable) => void) | Handler<Throwable>
Returns HttpConnection

getWindowSize

getWindowSize(): number

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3865
Returns number

goAway

goAway(errorCode: number): HttpConnection
goAway(errorCode: number, lastStreamId: number): HttpConnection
goAway(errorCode: number, lastStreamId: number, debugData: Buffer): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3879
Like {@link HttpConnection#goAway} with a last stream id -1 which means to disallow any new stream creation.

Parameters
- errorCode: number
Returns HttpConnection
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3884
Like {@link HttpConnection#goAway} with no buffer.

Parameters
- errorCode: number
- lastStreamId: number
Returns HttpConnection
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3897
Send a go away frame to the remote endpoint of the connection.
- a frame is sent to the to the remote endpoint with the errorCode and debugData
- any stream created after the stream identified by lastStreamId will be closed
- for an is different than 0 when all the remaining streams are closed this connection will be closed automatically
This is not implemented for HTTP/1.x.
Parameters
- errorCode: number
- lastStreamId: number
- debugData: Buffer
Returns HttpConnection

goAwayHandler

goAwayHandler(handler: ((res: GoAway) => void) | Handler<GoAway> | null | undefined): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3904
Set an handler called when a frame is received.

This is not implemented for HTTP/1.x.

Parameters
- handler: ((res: GoAway) => void) | Handler<GoAway> | null | undefined
Returns HttpConnection

indicatedServerName

indicatedServerName(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4052
Returns the SNI server name presented during the SSL handshake by the client.

Returns string

isSsl

isSsl(): boolean

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4047
Returns boolean

localAddress

localAddress(): SocketAddress
localAddress(real: boolean): SocketAddress

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4038
Returns SocketAddress
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4043
Like {@link HttpConnection#localAddress} ()} but returns the server local address when real is true

Parameters
- real: boolean
Returns SocketAddress

ping

ping(data: Buffer): PromiseLike<Buffer>
ping(data: Buffer, pongHandler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4006
Send a frame to the remote endpoint.

This is not implemented for HTTP/1.x.

Parameters
- data: Buffer
Returns PromiseLike<Buffer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4013
Send a frame to the remote endpoint.

This is not implemented for HTTP/1.x.

Parameters
- data: Buffer
- pongHandler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>
Returns HttpConnection

pingHandler

pingHandler(handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4020
Set an handler notified when a frame is received from the remote endpoint.

This is not implemented for HTTP/1.x.

Parameters
- handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined
Returns HttpConnection

remoteAddress

remoteAddress(): SocketAddress
remoteAddress(real: boolean): SocketAddress

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4029
Returns SocketAddress
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4034
Like {@link HttpConnection#remoteAddress} but returns the proxy remote address when real is true

Parameters
- real: boolean
Returns SocketAddress

remoteSettings

remoteSettings(): Http2Settings

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3992
Returns Http2Settings

remoteSettingsHandler

remoteSettingsHandler(handler: ((res: Http2Settings) => void) | Handler<Http2Settings>): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3999
Set an handler that is called when remote endpoint Http2Settings are updated.

This is not implemented for HTTP/1.x.

Parameters
- handler: ((res: Http2Settings) => void) | Handler<Http2Settings>
Returns HttpConnection

setWindowSize

setWindowSize(windowSize: number): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3874
Update the current connection wide window size to a new size.

Increasing this value, gives better performance when several data streams are multiplexed
This is not implemented for HTTP/1.x.

Parameters
- windowSize: number
Returns HttpConnection

settings

settings(): Http2Settings

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3970
Returns Http2Settings

shutdown

shutdown(): PromiseLike<void>
shutdown(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
shutdown(timeout: number): PromiseLike<void>
shutdown(timeout: number, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3924
Initiate a graceful connection shutdown, the connection is taken out of service and closed when all current requests are processed, otherwise after 30 seconds the connection will be closed. Client connection are immediately removed from the pool.
- HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close
- HTTP/1.x client connection supports this feature
- HTTP/1.x server connections do not support this feature
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3937
Initiate a graceful connection shutdown, the connection is taken out of service and closed when all current requests are processed, otherwise after 30 seconds the connection will be closed. Client connection are immediately removed from the pool.
- HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close
- HTTP/1.x client connection supports this feature
- HTTP/1.x server connections do not support this feature
Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3942
Like {@link HttpConnection#shutdown} but with a specific timeout in milliseconds.

Parameters
- timeout: number
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3947
Like {@link HttpConnection#shutdown} but with a specific timeout in milliseconds.

Parameters
- timeout: number
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

shutdownHandler

shutdownHandler(handler: ((res: void) => void) | Handler<void> | null | undefined): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3911
Set an handler called when a frame has been sent or received and all connections are closed.

This is not implemented for HTTP/1.x.

Parameters
- handler: ((res: void) => void) | Handler<void> | null | undefined
Returns HttpConnection

sslSession

sslSession(): any

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:4056
Returns any

updateSettings

updateSettings(settings: Http2Settings): PromiseLike<void>
updateSettings(settings: Http2Settings, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): HttpConnection

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3979
Send to the remote endpoint an update of this endpoint settings

The completionHandler will be notified when the remote endpoint has acknowledged the settings.
This is not implemented for HTTP/1.x.

Parameters
- settings: Http2Settings
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3988
Send to the remote endpoint an update of this endpoint settings

The completionHandler will be notified when the remote endpoint has acknowledged the settings.
This is not implemented for HTTP/1.x.

Parameters
- settings: Http2Settings
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns HttpConnection

Hierarchy

Index

Methods

Methods

close

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

closeHandler

Parameters

handler: ((res: void) => void) | Handler<void>

Returns HttpConnection

exceptionHandler

Parameters

handler: ((res: Throwable) => void) | Handler<Throwable>

Returns HttpConnection

getWindowSize

Returns number

goAway

Parameters

errorCode: number

Returns HttpConnection

Parameters

errorCode: number

lastStreamId: number

Returns HttpConnection

Parameters

errorCode: number

lastStreamId: number

debugData: Buffer

Returns HttpConnection

goAwayHandler

Parameters

handler: ((res: GoAway) => void) | Handler<GoAway> | null | undefined

Returns HttpConnection

indicatedServerName

Returns string

isSsl

Returns boolean

localAddress

Returns SocketAddress

Parameters

real: boolean

Returns SocketAddress

ping

Parameters

data: Buffer

Returns PromiseLike<Buffer>

Parameters

data: Buffer

pongHandler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>

Returns HttpConnection

pingHandler

Parameters

handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined

Returns HttpConnection

remoteAddress

Returns SocketAddress

Parameters

real: boolean

Returns SocketAddress

remoteSettings

Returns Http2Settings

remoteSettingsHandler

Parameters

handler: ((res: Http2Settings) => void) | Handler<Http2Settings>

Returns HttpConnection

setWindowSize

Parameters

windowSize: number

Returns HttpConnection

settings

Returns Http2Settings

shutdown

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Parameters