Packages

c

akka.http.scaladsl.Http

ServerBinding

final case class ServerBinding(localAddress: InetSocketAddress)(unbindAction: () ⇒ Future[Unit], terminateAction: (FiniteDuration) ⇒ Future[HttpTerminated]) extends Product with Serializable

Represents a prospective HTTP server binding.

localAddress

The local address of the endpoint bound by the materialization of the connections akka.stream.scaladsl.Source

Source
Http.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerBinding
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ServerBinding(localAddress: InetSocketAddress)(unbindAction: () ⇒ Future[Unit], terminateAction: (FiniteDuration) ⇒ Future[HttpTerminated])

    localAddress

    The local address of the endpoint bound by the materialization of the connections akka.stream.scaladsl.Source

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ServerBinding to any2stringadd[ServerBinding] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ServerBinding, B)
    Implicit
    This member is added by an implicit conversion from ServerBinding to ArrowAssoc[ServerBinding] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (ServerBinding) ⇒ Boolean, msg: ⇒ Any): ServerBinding
    Implicit
    This member is added by an implicit conversion from ServerBinding to Ensuring[ServerBinding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ServerBinding) ⇒ Boolean): ServerBinding
    Implicit
    This member is added by an implicit conversion from ServerBinding to Ensuring[ServerBinding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ServerBinding
    Implicit
    This member is added by an implicit conversion from ServerBinding to Ensuring[ServerBinding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ServerBinding
    Implicit
    This member is added by an implicit conversion from ServerBinding to Ensuring[ServerBinding] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ServerBinding to StringFormat[ServerBinding] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val localAddress: InetSocketAddress
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def terminate(hardDeadline: FiniteDuration): Future[HttpTerminated]

    Triggers "graceful" termination request being handled on this connection.

    Triggers "graceful" termination request being handled on this connection.

    Termination works as follows:

    1) Unbind: - the server port is unbound; no new connections will be accepted.

    1.5) Immediately the ServerBinding whenTerminationSignalIssued future is completed. This can be used to signal parts of the application that the http server is shutting down and they should clean up as well. Note also that for more advanced shut down scenarios you may want to use the Coordinated Shutdown capabilities of Akka.

    2) if a connection has no "in-flight" request, it is terminated immediately

    3) Handle in-flight request: - if a request is "in-flight" (being handled by user code), it is given hardDeadline time to complete,

    • if user code emits a response within the timeout, then this response is sent to the client with a Connection: close header and the connection is closed.
      • however if it is a streaming response, it is also mandated that it shall complete within the deadline, and if it does not the connection will be terminated regardless of status of the streaming response (this is because such response could be infinite, which could trap the server in a situation where it could not terminate if it were to wait for a response to "finish")
      • existing streaming responses must complete before the deadline as well. When the deadline is reached the connection will be terminated regardless of status of the streaming responses.
    • if user code does not reply with a response within the deadline we produce a special akka.http.javadsl.settings.ServerSettings.getTerminationDeadlineExceededResponse HTTP response (e.g. 503 Service Unavailable)

    4) Keep draining incoming requests on existing connection: - The existing connection will remain alive for until the hardDeadline is exceeded, yet no new requests will be delivered to the user handler. All such drained responses will be replied to with an termination response (as explained in phase 3).

    5) Close still existing connections - Connections are terminated forcefully once the hardDeadline is exceeded. The whenTerminated future is completed as well, so the graceful termination (of the ActorSystem or entire JVM itself can be safely performed, as by then it is known that no connections remain alive to this server).

    Note that the termination response is configurable in akka.http.javadsl.settings.ServerSettings, and by default is an 503 Service Unavailable, with an empty response entity.

    hardDeadline

    timeout after which all requests and connections shall be forcefully terminated

    returns

    future which completes successfully with a marker object once all connections have been terminated

  23. def unbind(): Future[Done]

    Asynchronously triggers the unbinding of the port that was bound by the materialization of the connections akka.stream.scaladsl.Source

    Asynchronously triggers the unbinding of the port that was bound by the materialization of the connections akka.stream.scaladsl.Source

    Note that unbinding does NOT terminate existing connections. Unbinding only means that the server will not accept new connections, and existing connections are allowed to still perform request/response cycles. This can be useful when one wants to let clients finish whichever work they have remaining, while signalling them using some other way that the server will be terminating soon -- e.g. by sending such information in the still being sent out responses, such that the client can switch to a new server when it is ready.

    Alternatively you may want to use the terminate method which unbinds and performs some level of gracefully replying with

    The produced scala.concurrent.Future is fulfilled when the unbinding has been completed.

  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def whenTerminated: Future[HttpTerminated]

    This future completes when the termination process, as initiated by an terminate call has completed.

    This future completes when the termination process, as initiated by an terminate call has completed. This means that the server is by then: unbound, and has closed all existing connections.

    This signal can for example be used to safely terminate the underlying ActorSystem.

    Note: This mechanism is currently NOT hooked into the Coordinated Shutdown mechanisms of Akka. TODO: This feature request is tracked by: https://github.com/akka/akka-http/issues/1210

    Note that this signal may be used for Coordinated Shutdown to proceed to next steps in the shutdown. You may also explicitly depend on this future to perform your next shutting down steps.

  28. def whenTerminationSignalIssued: Future[Deadline]

    Completes when the terminate is called and server termination is in progress.

    Completes when the terminate is called and server termination is in progress. Can be useful to make parts of your application aware that termination has been issued, and they have Deadline time remaining to clean-up before the server will forcefully close existing connections.

    Note that while termination is in progress, no new connections will be accepted (i.e. termination implies prior unbind).

  29. def [B](y: B): (ServerBinding, B)
    Implicit
    This member is added by an implicit conversion from ServerBinding to ArrowAssoc[ServerBinding] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ServerBinding to any2stringadd[ServerBinding]

Inherited by implicit conversion StringFormat from ServerBinding to StringFormat[ServerBinding]

Inherited by implicit conversion Ensuring from ServerBinding to Ensuring[ServerBinding]

Inherited by implicit conversion ArrowAssoc from ServerBinding to ArrowAssoc[ServerBinding]

Ungrouped