Http2UpgradedClientConnection (Vertx Javadocs 3.9.1.GA API)

java.lang.Object
- io.vertx.core.http.impl.Http2UpgradedClientConnection

All Implemented Interfaces:

HttpConnection, HttpClientConnection
```
public class Http2UpgradedClientConnection
extends Object
implements HttpClientConnection
```
An HTTP/2 connection in clear text that upgraded from an HTTP/1 upgrade.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.netty.channel.Channel`	`channel()`
`io.netty.channel.ChannelHandlerContext`	`channelHandlerContext()`
`void`	`close()` Close the connection and all the currently active streams.
`HttpConnection`	`closeHandler(Handler<Void> handler)` Set a close handler.
`void`	`createStream(Handler<AsyncResult<io.vertx.core.http.impl.HttpClientStream>> handler)`
`HttpConnection`	`exceptionHandler(Handler<Throwable> handler)` Set an handler called when a connection error happens
`ContextInternal`	`getContext()`
`HttpConnection`	`goAway(long errorCode, int lastStreamId, Buffer debugData)` Send a go away frame to the remote endpoint of the connection.
`HttpConnection`	`goAwayHandler(Handler<GoAway> handler)` Set an handler called when a GOAWAY frame is received.
`String`	`indicatedServerName()` Returns the SNI server name presented during the SSL handshake by the client.
`boolean`	`isSsl()`
`boolean`	`isValid()`
`SocketAddress`	`localAddress()`
`Object`	`metric()`
`X509Certificate[]`	`peerCertificateChain()` Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on.
`HttpConnection`	`ping(Buffer data, Handler<AsyncResult<Buffer>> pongHandler)` Send a PING frame to the remote endpoint.
`HttpConnection`	`pingHandler(Handler<Buffer> handler)` Set an handler notified when a PING frame is received from the remote endpoint.
`SocketAddress`	`remoteAddress()`
`Http2Settings`	`remoteSettings()`
`HttpConnection`	`remoteSettingsHandler(Handler<Http2Settings> handler)` Set an handler that is called when remote endpoint `Http2Settings` are updated.
`Http2Settings`	`settings()`
`HttpConnection`	`shutdown(long timeoutMs)` Like `HttpConnection.shutdown()` but with a configurable timeout value.
`HttpConnection`	`shutdownHandler(Handler<Void> handler)` Set an handler called when a GOAWAY frame has been sent or received and all connections are closed.
`SSLSession`	`sslSession()`
`HttpConnection`	`updateSettings(Http2Settings settings)` Send to the remote endpoint an update of the server settings.
`HttpConnection`	`updateSettings(Http2Settings settings, Handler<AsyncResult<Void>> completionHandler)` Send to the remote endpoint an update of this endpoint settings The `completionHandler` will be notified when the remote endpoint has acknowledged the settings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.core.http.HttpConnection
getWindowSize, goAway, goAway, setWindowSize, shutdown

- Method Detail
  - channelHandlerContext
```
public io.netty.channel.ChannelHandlerContext channelHandlerContext()
```
    Specified by:
    
    channelHandlerContext in interface HttpClientConnection
  - channel
```
public io.netty.channel.Channel channel()
```
    Specified by:
    
    channel in interface HttpClientConnection
  - close
```
public void close()
```
    Description copied from interface: HttpConnection
    
    Close the connection and all the currently active streams.
    An HTTP/2 connection will send a GOAWAY frame before.
    
    Specified by:
    
    close in interface HttpConnection
    
    Specified by:
    
    close in interface HttpClientConnection
  - metric
```
public Object metric()
```
    Specified by:
    
    metric in interface HttpClientConnection
  - createStream
```
public void createStream(Handler<AsyncResult<io.vertx.core.http.impl.HttpClientStream>> handler)
```
    Specified by:
    
    createStream in interface HttpClientConnection
  - getContext
```
public ContextInternal getContext()
```
    Specified by:
    
    getContext in interface HttpClientConnection
  - closeHandler
```
public HttpConnection closeHandler(Handler<Void> handler)
```
    Description copied from interface: HttpConnection
    
    Set a close handler. The handler will get notified when the connection is closed.
    
    Specified by:
    
    closeHandler in interface HttpConnection
    
    Parameters:
    
    handler - the handler to be notified
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - exceptionHandler
```
public HttpConnection exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: HttpConnection
    
    Set an handler called when a connection error happens
    
    Specified by:
    
    exceptionHandler in interface HttpConnection
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - remoteSettingsHandler
```
public HttpConnection remoteSettingsHandler(Handler<Http2Settings> handler)
```
    Description copied from interface: HttpConnection
    
    Set an handler that is called when remote endpoint Http2Settings are updated.
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    remoteSettingsHandler in interface HttpConnection
    
    Parameters:
    
    handler - the handler for remote endpoint settings
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pingHandler
```
public HttpConnection pingHandler(Handler<Buffer> handler)
```
    Description copied from interface: HttpConnection
    
    Set an handler notified when a PING frame is received from the remote endpoint.
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    pingHandler in interface HttpConnection
    
    Parameters:
    
    handler - the handler to be called when a PING is received
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - goAwayHandler
```
public HttpConnection goAwayHandler(Handler<GoAway> handler)
```
    Description copied from interface: HttpConnection
    
    Set an handler called when a GOAWAY frame is received.
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    goAwayHandler in interface HttpConnection
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - shutdownHandler
```
public HttpConnection shutdownHandler(Handler<Void> handler)
```
    Description copied from interface: HttpConnection
    
    Set an handler called when a GOAWAY frame has been sent or received and all connections are closed.
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    shutdownHandler in interface HttpConnection
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - goAway
```
public HttpConnection goAway(long errorCode,
                             int lastStreamId,
                             Buffer debugData)
```
    Description copied from interface: HttpConnection
    Send a go away frame to the remote endpoint of the connection.
    - a GOAWAY 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 errorCode 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.
    Specified by:
    
    goAway in interface HttpConnection
    
    Parameters:
    
    errorCode - the GOAWAY error code
    
    lastStreamId - the last stream id
    
    debugData - additional debug data sent to the remote endpoint
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - shutdown
```
public HttpConnection shutdown(long timeoutMs)
```
    Description copied from interface: HttpConnection
    
    Like HttpConnection.shutdown() but with a configurable timeout value.
    
    Specified by:
    
    shutdown in interface HttpConnection
    
    Parameters:
    
    timeoutMs - the timeout in milliseconds
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - updateSettings
```
public HttpConnection updateSettings(Http2Settings settings)
```
    Description copied from interface: HttpConnection
    
    Send to the remote endpoint an update of the server settings.
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    updateSettings in interface HttpConnection
    
    Parameters:
    
    settings - the new settings
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - updateSettings
```
public HttpConnection updateSettings(Http2Settings settings,
                                     Handler<AsyncResult<Void>> completionHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateSettings in interface HttpConnection
    
    Parameters:
    
    settings - the new settings
    
    completionHandler - the handler notified when the settings have been acknowledged by the remote endpoint
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - settings
```
public Http2Settings settings()
```
    Specified by:
    
    settings in interface HttpConnection
    
    Returns:
    
    the latest server settings acknowledged by the remote endpoint - this is not implemented for HTTP/1.x
  - remoteSettings
```
public Http2Settings remoteSettings()
```
    Specified by:
    
    remoteSettings in interface HttpConnection
    
    Returns:
    
    the current remote endpoint settings for this connection - this is not implemented for HTTP/1.x
  - ping
```
public HttpConnection ping(Buffer data,
                           Handler<AsyncResult<Buffer>> pongHandler)
```
    Description copied from interface: HttpConnection
    
    Send a PING frame to the remote endpoint.
    This is not implemented for HTTP/1.x.
    
    Specified by:
    
    ping in interface HttpConnection
    
    Parameters:
    
    data - the 8 bytes data of the frame
    
    pongHandler - an async result handler notified with pong reply or the failure
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - remoteAddress
```
public SocketAddress remoteAddress()
```
    Specified by:
    
    remoteAddress in interface HttpConnection
    
    Returns:
    
    the remote address for this connection, possibly null (e.g a server bound on a domain socket)
  - localAddress
```
public SocketAddress localAddress()
```
    Specified by:
    
    localAddress in interface HttpConnection
    
    Returns:
    
    the local address for this connection, possibly null (e.g a server bound on a domain socket)
  - isSsl
```
public boolean isSsl()
```
    Specified by:
    
    isSsl in interface HttpConnection
    
    Returns:
    
    true if this HttpConnection is encrypted via SSL/TLS.
  - sslSession
```
public SSLSession sslSession()
```
    Specified by:
    
    sslSession in interface HttpConnection
    
    Returns:
    
    SSLSession associated with the underlying socket. Returns null if connection is not SSL.
    
    See Also:
    
    SSLSession
  - peerCertificateChain
```
public X509Certificate[] peerCertificateChain()
                                       throws SSLPeerUnverifiedException
```
    Description copied from interface: HttpConnection
    
    Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on. Use HttpConnection.sslSession() to access that method.
    
    Specified by:
    
    peerCertificateChain in interface HttpConnection
    
    Returns:
    
    an ordered array of the peer certificates. Returns null if connection is not SSL.
    
    Throws:
    
    SSLPeerUnverifiedException - SSL peer's identity has not been verified.
    
    See Also:
    
    SSLSession.getPeerCertificateChain(), HttpConnection.sslSession()
  - indicatedServerName
```
public String indicatedServerName()
```
    Description copied from interface: HttpConnection
    
    Returns the SNI server name presented during the SSL handshake by the client.
    
    Specified by:
    
    indicatedServerName in interface HttpConnection
    
    Returns:
    
    the indicated server name
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface HttpClientConnection

Class Http2UpgradedClientConnection

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.core.http.HttpConnection

Method Detail

channelHandlerContext

channel

close

metric

createStream

getContext

closeHandler

exceptionHandler

remoteSettingsHandler

pingHandler

goAwayHandler

shutdownHandler

goAway

shutdown

updateSettings

updateSettings

settings

remoteSettings

ping

remoteAddress

localAddress

isSsl

sslSession

peerCertificateChain

indicatedServerName

isValid