Package io.vertx.rxjava3.core.http
Class HttpConnection
- java.lang.Object
-
- io.vertx.rxjava3.core.http.HttpConnection
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
- Direct Known Subclasses:
HttpClientConnection
public class HttpConnection extends Object implements io.vertx.lang.rx.RxDelegate
Represents an HTTP connection. HTTP/1.x connection provides a limited implementation, the following methods are implemented:close()closeHandler(io.vertx.core.Handler<java.lang.Void>)exceptionHandler(io.vertx.core.Handler<java.lang.Throwable>)
NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<HttpConnection>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description HttpConnection(HttpConnection delegate)HttpConnection(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Completableclose()Close immediately (shutdown(0, TimeUnit.SECONDS).HttpConnectioncloseHandler(Handler<Void> handler)Set a close handler.booleanequals(Object o)HttpConnectionexceptionHandler(Handler<Throwable> handler)Set an handler called when a connection error happensHttpConnectiongetDelegate()intgetWindowSize()HttpConnectiongoAway(long errorCode)LikegoAway(long)with a last stream id-1which means to disallow any new stream creation.HttpConnectiongoAway(long errorCode, int lastStreamId)LikegoAway(long)with no buffer.HttpConnectiongoAway(long errorCode, int lastStreamId, Buffer debugData)Send a go away frame to the remote endpoint of the connection.HttpConnectiongoAwayHandler(Handler<GoAway> handler)Set an handler called when a frame is received.inthashCode()StringindicatedServerName()Returns the SNI server name presented during the SSL handshake by the client.booleanisSsl()SocketAddresslocalAddress()SocketAddresslocalAddress(boolean real)static HttpConnectionnewInstance(HttpConnection arg)Single<Buffer>ping(Buffer data)Send a frame to the remote endpoint.HttpConnectionpingHandler(Handler<Buffer> handler)Set an handler notified when a frame is received from the remote endpoint.SocketAddressremoteAddress()SocketAddressremoteAddress(boolean real)Http2SettingsremoteSettings()HttpConnectionremoteSettingsHandler(Handler<Http2Settings> handler)Set an handler that is called when remote endpointHttp2Settingsare updated.CompletablerxClose()Close immediately (shutdown(0, TimeUnit.SECONDS).Single<Buffer>rxPing(Buffer data)Send a frame to the remote endpoint.CompletablerxShutdown()Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).CompletablerxShutdown(long timeout, TimeUnit unit)Initiate a graceful connection shutdown, the connection is taken out of service and closed when all the inflight requests are processed, otherwise after atimeoutthe connection will be closed.CompletablerxUpdateSettings(Http2Settings settings)Send to the remote endpoint an update of this endpoint settingsHttp2Settingssettings()HttpConnectionsetWindowSize(int windowSize)Update the current connection wide window size to a new size.Completableshutdown()Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).Completableshutdown(long timeout, TimeUnit unit)Initiate a graceful connection shutdown, the connection is taken out of service and closed when all the inflight requests are processed, otherwise after atimeoutthe connection will be closed.HttpConnectionshutdownHandler(Handler<Void> handler)Set ahandlernotified when the HTTP connection is shutdown: the client or server will close the connection within a certain amount of time.SSLSessionsslSession()StringtoString()CompletableupdateSettings(Http2Settings settings)Send to the remote endpoint an update of this endpoint settings
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<HttpConnection> __TYPE_ARG
-
-
Constructor Detail
-
HttpConnection
public HttpConnection(HttpConnection delegate)
-
HttpConnection
public HttpConnection(Object delegate)
-
-
Method Detail
-
getDelegate
public HttpConnection getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
getWindowSize
public int getWindowSize()
- Returns:
- the current connection window size or
-1for HTTP/1.x
-
setWindowSize
public HttpConnection setWindowSize(int windowSize)
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- the new window size- Returns:
- a reference to this, so the API can be used fluently
-
goAway
public HttpConnection goAway(long errorCode)
LikegoAway(long)with a last stream id-1which means to disallow any new stream creation.- Parameters:
errorCode-- Returns:
-
goAway
public HttpConnection goAway(long errorCode, int lastStreamId)
LikegoAway(long)with no buffer.- Parameters:
errorCode-lastStreamId-- Returns:
-
goAway
public HttpConnection goAway(long errorCode, int lastStreamId, Buffer debugData)
Send a go away frame to the remote endpoint of the connection.- a frame is sent to the to the remote endpoint with the
errorCodeanddebugData - any stream created after the stream identified by
lastStreamIdwill be closed - for an is different than
0when all the remaining streams are closed this connection will be closed automatically
- Parameters:
errorCode- the error codelastStreamId- the last stream iddebugData- additional debug data sent to the remote endpoint- Returns:
- a reference to this, so the API can be used fluently
- a frame is sent to the to the remote endpoint with the
-
goAwayHandler
public HttpConnection goAwayHandler(Handler<GoAway> handler)
Set an handler called when a frame is received. This is not implemented for HTTP/1.x.- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
shutdownHandler
public HttpConnection shutdownHandler(Handler<Void> handler)
Set ahandlernotified when the HTTP connection is shutdown: the client or server will close the connection within a certain amount of time. This gives the opportunity to thehandlerto close the current requests in progress gracefully before the HTTP connection is forcefully closed.- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
shutdown
public Completable shutdown()
Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).- Returns:
- a future completed when shutdown has completed
-
rxShutdown
public Completable rxShutdown()
Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).- Returns:
- a future completed when shutdown has completed
-
shutdown
public Completable shutdown(long timeout, TimeUnit unit)
Initiate a graceful connection shutdown, the connection is taken out of service and closed when all the inflight requests are processed, otherwise after atimeoutthe 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 connection will be closed.
- Parameters:
timeout- the amount of time after which all resources are forcibly closedunit- the of the timeout- Returns:
- a future completed when shutdown has completed
-
rxShutdown
public Completable rxShutdown(long timeout, TimeUnit unit)
Initiate a graceful connection shutdown, the connection is taken out of service and closed when all the inflight requests are processed, otherwise after atimeoutthe 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 connection will be closed.
- Parameters:
timeout- the amount of time after which all resources are forcibly closedunit- the of the timeout- Returns:
- a future completed when shutdown has completed
-
closeHandler
public HttpConnection closeHandler(Handler<Void> handler)
Set a close handler. The handler will get notified when the connection is closed.- Parameters:
handler- the handler to be notified- Returns:
- a reference to this, so the API can be used fluently
-
close
public Completable close()
Close immediately (shutdown(0, TimeUnit.SECONDS).- Returns:
- a future notified when the client is closed
-
rxClose
public Completable rxClose()
Close immediately (shutdown(0, TimeUnit.SECONDS).- Returns:
- a future notified when the client is closed
-
settings
public Http2Settings settings()
- Returns:
- the latest server settings acknowledged by the remote endpoint - this is not implemented for HTTP/1.x
-
updateSettings
public Completable updateSettings(Http2Settings settings)
Send to the remote endpoint an update of this endpoint settings ThecompletionHandlerwill be notified when the remote endpoint has acknowledged the settings. This is not implemented for HTTP/1.x.- Parameters:
settings- the new settings- Returns:
- a future completed when the settings have been acknowledged by the remote endpoint
-
rxUpdateSettings
public Completable rxUpdateSettings(Http2Settings settings)
Send to the remote endpoint an update of this endpoint settings ThecompletionHandlerwill be notified when the remote endpoint has acknowledged the settings. This is not implemented for HTTP/1.x.- Parameters:
settings- the new settings- Returns:
- a future completed when the settings have been acknowledged by the remote endpoint
-
remoteSettings
public Http2Settings remoteSettings()
- Returns:
- the current remote endpoint settings for this connection - this is not implemented for HTTP/1.x
-
remoteSettingsHandler
public HttpConnection remoteSettingsHandler(Handler<Http2Settings> handler)
Set an handler that is called when remote endpointHttp2Settingsare updated. This is not implemented for HTTP/1.x.- Parameters:
handler- the handler for remote endpoint settings- Returns:
- a reference to this, so the API can be used fluently
-
ping
public Single<Buffer> ping(Buffer data)
Send a frame to the remote endpoint. This is not implemented for HTTP/1.x.- Parameters:
data- the 8 bytes data of the frame- Returns:
- a future notified with the pong reply or the failure
-
rxPing
public Single<Buffer> rxPing(Buffer data)
Send a frame to the remote endpoint. This is not implemented for HTTP/1.x.- Parameters:
data- the 8 bytes data of the frame- Returns:
- a future notified with the pong reply or the failure
-
pingHandler
public HttpConnection pingHandler(Handler<Buffer> handler)
Set an handler notified when a frame is received from the remote endpoint. This is not implemented for HTTP/1.x.- Parameters:
handler- the handler to be called when a is received- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public HttpConnection exceptionHandler(Handler<Throwable> handler)
Set an handler called when a connection error happens- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
remoteAddress
public SocketAddress remoteAddress()
- Returns:
- the remote address for this connection, possibly
null(e.g a server bound on a domain socket). IfuseProxyProtocolis set totrue, the address returned will be of the actual connecting client.
-
remoteAddress
public SocketAddress remoteAddress(boolean real)
- Parameters:
real-- Returns:
-
localAddress
public SocketAddress localAddress()
- Returns:
- the local address for this connection, possibly
null(e.g a server bound on a domain socket) IfuseProxyProtocolis set totrue, the address returned will be of the proxy.
-
localAddress
public SocketAddress localAddress(boolean real)
- Parameters:
real-- Returns:
-
isSsl
public boolean isSsl()
- Returns:
- true if this
HttpConnectionis encrypted via SSL/TLS.
-
indicatedServerName
public String indicatedServerName()
Returns the SNI server name presented during the SSL handshake by the client.- Returns:
- the indicated server name
-
sslSession
public SSLSession sslSession()
- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
newInstance
public static HttpConnection newInstance(HttpConnection arg)
-
-