vertx / io.vertx.reactivex.core.http / HttpConnection

HttpConnection

open class HttpConnection

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

NOTE: This class has been automatically generated from the io.vertx.core.http.HttpConnection non RX-ified interface using Vert.x codegen.

Constructors

<init>

HttpConnection(delegate: HttpConnection)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<HttpConnection>

Functions

close

open fun close(): Unit

Close the connection and all the currently active streams. An HTTP/2 connection will send a frame before.

closeHandler

open fun closeHandler(handler: Handler<Void>): HttpConnection

Set a close handler. The handler will get notified when the connection is closed.

equals

open fun equals(other: Any?): Boolean

exceptionHandler

open fun exceptionHandler(handler: Handler<Throwable>): HttpConnection

Set an handler called when a connection error happens

getDelegate

open fun getDelegate(): HttpConnection

getWindowSize

open fun getWindowSize(): Int

goAway

open fun goAway(errorCode: Long): HttpConnection

Like io.vertx.reactivex.core.http.HttpConnection#goAway with a last stream id 2^31-1.

open fun goAway(errorCode: Long, lastStreamId: Int): HttpConnection

Like io.vertx.reactivex.core.http.HttpConnection#goAway with no buffer.

open fun goAway(errorCode: Long, lastStreamId: Int, debugData: Buffer): HttpConnection

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.

goAwayHandler

open fun goAwayHandler(handler: Handler<GoAway>): HttpConnection

Set an handler called when a frame is received. This is not implemented for HTTP/1.x.

hashCode

open fun hashCode(): Int

indicatedServerName

open fun indicatedServerName(): String

Returns the SNI server name presented during the SSL handshake by the client.

isSsl

open fun isSsl(): Boolean

localAddress

open fun localAddress(): SocketAddress

newInstance

open static fun newInstance(arg: HttpConnection): HttpConnection

ping

open fun ping(data: Buffer, pongHandler: Handler<AsyncResult<Buffer>>): HttpConnection

Send a frame to the remote endpoint. This is not implemented for HTTP/1.x.

pingHandler

open fun pingHandler(handler: Handler<Buffer>): HttpConnection

Set an handler notified when a frame is received from the remote endpoint. This is not implemented for HTTP/1.x.

remoteAddress

open fun remoteAddress(): SocketAddress

remoteSettings

open fun remoteSettings(): Http2Settings

remoteSettingsHandler

open fun remoteSettingsHandler(handler: Handler<Http2Settings>): HttpConnection

Set an handler that is called when remote endpoint io.vertx.core.http.Http2Settings are updated. This is not implemented for HTTP/1.x.

rxPing

open fun rxPing(data: Buffer): Single<Buffer>

Send a frame to the remote endpoint. This is not implemented for HTTP/1.x.

rxUpdateSettings

open fun rxUpdateSettings(settings: Http2Settings): Completable

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.

setWindowSize

open fun setWindowSize(windowSize: Int): HttpConnection

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.

settings

open fun settings(): Http2Settings

shutdown

open fun shutdown(): HttpConnection

Initiate a connection shutdown, a go away frame is sent and the connection is closed when all current active streams are closed or after a time out of 30 seconds. This is not implemented for HTTP/1.x.

open fun shutdown(timeoutMs: Long): HttpConnection

Initiate a connection shutdown, a go away frame is sent and the connection is closed when all current streams will be closed or the timeout is fired. This is not implemented for HTTP/1.x.

shutdownHandler

open fun shutdownHandler(handler: Handler<Void>): HttpConnection

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.

toString

open fun toString(): String

updateSettings

open fun updateSettings(settings: Http2Settings): HttpConnection

Send to the remote endpoint an update of the server settings. This is not implemented for HTTP/1.x.

open fun updateSettings(settings: Http2Settings, completionHandler: Handler<AsyncResult<Void>>): HttpConnection

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.