vertx-lang-scala-docs_2.12 3.9.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package http
  Definition Classes
    core
- Cookie
- GoAway
- Http2Settings
- HttpClient
- HttpClientOptions
- HttpClientRequest
- HttpClientResponse
- HttpConnection
- HttpFrame
- HttpServer
- HttpServerFileUpload
- HttpServerOptions
- HttpServerRequest
- HttpServerResponse
- RequestOptions
- ServerWebSocket
- StreamPriority
- WebSocket
- WebSocketBase
- WebSocketConnectOptions
- WebSocketFrame

c

io.vertx.scala.core.http

# HttpConnection 

###
Companion object HttpConnection

#### class HttpConnection extends AnyRef

Represents an HTTP connection.

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

- io.vertx.scala.core.http.HttpConnection#close
- io.vertx.scala.core.http.HttpConnection#closeHandler
- io.vertx.scala.core.http.HttpConnection#exceptionHandler

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. HttpConnection
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new HttpConnection(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
7.  def close(): Unit

   Close the connection and all the currently active streams.

   Close the connection and all the currently active streams.

   An HTTP/2 connection will send a frame before.

8.  def closeHandler(handler: Handler[Unit]): HttpConnection

   Set a close handler.

   Set a close handler. The handler will get notified when the connection is closed. * @param handler the handler to be notified

   returns

     a reference to this, so the API can be used fluently

9.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
10.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
11.  def exceptionHandler(handler: Handler[Throwable]): HttpConnection

    Set an handler called when a connection error happens * @param handler the handler

    Set an handler called when a connection error happens * @param handler the handler

    returns

      a reference to this, so the API can be used fluently

12.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
13.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
14.  def getWindowSize(): Int

    returns

      the current connection window size or `-1` for HTTP/1.x

15.  def goAway(errorCode: Long, lastStreamId: Int, debugData: Buffer): HttpConnection

    Send a go away frame to the remote endpoint of the connection.

    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. * @param 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

16.  def goAway(errorCode: Long, lastStreamId: Int): HttpConnection

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

17.  def goAway(errorCode: Long): HttpConnection

    Like io.vertx.scala.core.http.HttpConnection#goAway with a last stream id `-1` which means to disallow any new stream creation.

18.  def goAwayHandler(handler: Handler[GoAway]): HttpConnection

    Set an handler called when a frame is received.

    Set an handler called when a frame is received.

    This is not implemented for HTTP/1.x. * @param handler the handler

    returns

      a reference to this, so the API can be used fluently

19.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
20.  def indicatedServerName(): String

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

    Returns the SNI server name presented during the SSL handshake by the client. * @return the indicated server name

21.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
22.  def isSsl(): Boolean

    returns

      true if this io.vertx.scala.core.http.HttpConnection is encrypted via SSL/TLS.

23.  def localAddress(): SocketAddress

    returns

      the local address for this connection, possibly `null` (e.g a server bound on a domain socket)

24.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
25.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
27.  def ping(data: Buffer, pongHandler: Handler[AsyncResult[Buffer]]): HttpConnection

    Send a frame to the remote endpoint.

    Send a frame to the remote endpoint.

    This is not implemented for HTTP/1.x. * @param 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

28.  def pingFuture(data: Buffer): scala.concurrent.Future[Buffer]

    Like ping but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

29.  def pingHandler(handler: Handler[Buffer]): HttpConnection

    Set an handler notified when a frame is received from the remote endpoint.

    Set an handler notified when a frame is received from the remote endpoint.

    This is not implemented for HTTP/1.x. * @param handler the handler to be called when a `PING` is received

    returns

      a reference to this, so the API can be used fluently

30.  def remoteAddress(): SocketAddress

    returns

      the remote address for this connection, possibly `null` (e.g a server bound on a domain socket)

31.  def remoteSettings(): Http2Settings

    returns

      the current remote endpoint settings for this connection - this is not implemented for HTTP/1.xsee Http2Settings

32.  def remoteSettingsHandler(handler: Handler[Http2Settings]): HttpConnection

    Set an handler that is called when remote endpoint Http2Settings are updated.

    Set an handler that is called when remote endpoint Http2Settings are updated.

    This is not implemented for HTTP/1.x. * @param handler the handler for remote endpoint settings

    returns

      a reference to this, so the API can be used fluently

33.  def setWindowSize(windowSize: Int): HttpConnection

    Update the current connection wide window size to a new size.

    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. * @param windowSize the new window size

    returns

      a reference to this, so the API can be used fluently

34.  def settings(): Http2Settings

    returns

      the latest server settings acknowledged by the remote endpoint - this is not implemented for HTTP/1.xsee Http2Settings

35.  def shutdown(timeoutMs: Long): HttpConnection

    Like io.vertx.scala.core.http.HttpConnection#shutdown but with a configurable timeout value.

    Like io.vertx.scala.core.http.HttpConnection#shutdown but with a configurable timeout value. * @param timeoutMs the timeout in milliseconds

    returns

      a reference to this, so the API can be used fluently

36.  def shutdown(): HttpConnection

    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.

    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 * @return a reference to this, so the API can be used fluently
37.  def shutdownHandler(handler: Handler[Unit]): HttpConnection

    Set an handler called when a frame has been sent or received and all connections are closed.

    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. * @param handler the handler

    returns

      a reference to this, so the API can be used fluently

38.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
39.  def toString(): String
    Definition Classes
      AnyRef → Any
40.  def updateSettings(settings: Http2Settings, completionHandler: Handler[AsyncResult[Unit]]): HttpConnection

    Send to the remote endpoint an update of this endpoint settings

    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. * @param settings the new settings see Http2Settings

    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

41.  def updateSettings(settings: Http2Settings): HttpConnection

    Send to the remote endpoint an update of the server settings.

    Send to the remote endpoint an update of the server settings.

    This is not implemented for HTTP/1.x. * @param settings the new settings see Http2Settings

    returns

      a reference to this, so the API can be used fluently

42.  def updateSettingsFuture(settings: Http2Settings): scala.concurrent.Future[Unit]

    Like updateSettings but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

43.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
44.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
45.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped