Packages

class HttpExt extends Extension with DefaultSSLContextCreation

Akka extension for HTTP which serves as the main entry point into akka-http.

Use as Http().bindAndHandle etc. with an implicit ActorSystem in scope.

Annotations
@DoNotInherit()
Source
Http.scala
Linear Supertypes
DefaultSSLContextCreation, Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpExt
  2. DefaultSSLContextCreation
  3. Extension
  4. AnyRef
  5. 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

Type Members

  1. type ClientLayer = BidiFlow[HttpRequest, SslTlsOutbound, SslTlsInbound, HttpResponse, NotUsed]
  2. type ServerLayer = BidiFlow[HttpResponse, SslTlsOutbound, SslTlsInbound, HttpRequest, NotUsed]

Value Members

  1. def bind(interface: String, port: Int = DefaultPortForProtocol, connectionContext: ConnectionContext = defaultServerHttpContext, settings: ServerSettings = ServerSettings(system), log: LoggingAdapter = system.log): Source[IncomingConnection, Future[ServerBinding]]

    Creates a akka.stream.scaladsl.Source of akka.http.scaladsl.Http.IncomingConnection instances which represents a prospective HTTP server binding on the given endpoint.

    Creates a akka.stream.scaladsl.Source of akka.http.scaladsl.Http.IncomingConnection instances which represents a prospective HTTP server binding on the given endpoint.

    If the given port is 0 the resulting source can be materialized several times. Each materialization will then be assigned a new local port by the operating system, which can then be retrieved by the materialized akka.http.scaladsl.Http.ServerBinding.

    If the given port is non-zero subsequent materialization attempts of the produced source will immediately fail, unless the first materialization has already been unbound. Unbinding can be triggered via the materialized akka.http.scaladsl.Http.ServerBinding.

    If an ConnectionContext is given it will be used for setting up TLS encryption on the binding. Otherwise the binding will be unencrypted.

    If no port is explicitly given (or the port value is negative) the protocol's default port will be used, which is 80 for HTTP and 443 for HTTPS.

    To configure additional settings for a server started using this method, use the akka.http.server config section or pass in a akka.http.scaladsl.settings.ServerSettings explicitly.

  2. def bindAndHandle(handler: Flow[HttpRequest, HttpResponse, Any], interface: String, port: Int = DefaultPortForProtocol, connectionContext: ConnectionContext = defaultServerHttpContext, settings: ServerSettings = ServerSettings(system), log: LoggingAdapter = system.log)(implicit fm: Materializer): Future[ServerBinding]

    Convenience method which starts a new HTTP server at the given endpoint and uses the given handler akka.stream.scaladsl.Flow for processing all incoming connections.

    Convenience method which starts a new HTTP server at the given endpoint and uses the given handler akka.stream.scaladsl.Flow for processing all incoming connections.

    The number of concurrently accepted connections can be configured by overriding the akka.http.server.max-connections setting. Please see the documentation in the reference.conf for more information about what kind of guarantees to expect.

    To configure additional settings for a server started using this method, use the akka.http.server config section or pass in a akka.http.scaladsl.settings.ServerSettings explicitly.

  3. def bindAndHandleAsync(handler: (HttpRequest) ⇒ Future[HttpResponse], interface: String, port: Int = DefaultPortForProtocol, connectionContext: ConnectionContext = defaultServerHttpContext, settings: ServerSettings = ServerSettings(system), parallelism: Int = 0, log: LoggingAdapter = system.log)(implicit fm: Materializer): Future[ServerBinding]

    Convenience method which starts a new HTTP server at the given endpoint and uses the given handler akka.stream.scaladsl.Flow for processing all incoming connections.

    Convenience method which starts a new HTTP server at the given endpoint and uses the given handler akka.stream.scaladsl.Flow for processing all incoming connections.

    The number of concurrently accepted connections can be configured by overriding the akka.http.server.max-connections setting. Please see the documentation in the reference.conf for more information about what kind of guarantees to expect.

    To configure additional settings for a server started using this method, use the akka.http.server config section or pass in a akka.http.scaladsl.settings.ServerSettings explicitly.

    Parameter parallelism specifies how many requests are attempted to be handled concurrently per connection. In HTTP/1 this makes only sense if HTTP pipelining is enabled (which is not recommended). The default value of 0 means that the value is taken from the akka.http.server.pipelining-limit setting from the configuration. In HTTP/2, the default value is taken from akka.http.server.http2.max-concurrent-streams.

    Any other value for parallelism overrides the setting.

  4. def bindAndHandleSync(handler: (HttpRequest) ⇒ HttpResponse, interface: String, port: Int = DefaultPortForProtocol, connectionContext: ConnectionContext = defaultServerHttpContext, settings: ServerSettings = ServerSettings(system), log: LoggingAdapter = system.log)(implicit fm: Materializer): Future[ServerBinding]

    Convenience method which starts a new HTTP server at the given endpoint and uses the given handler akka.stream.scaladsl.Flow for processing all incoming connections.

    Convenience method which starts a new HTTP server at the given endpoint and uses the given handler akka.stream.scaladsl.Flow for processing all incoming connections.

    The number of concurrently accepted connections can be configured by overriding the akka.http.server.max-connections setting. Please see the documentation in the reference.conf for more information about what kind of guarantees to expect.

    To configure additional settings for a server started using this method, use the akka.http.server config section or pass in a akka.http.scaladsl.settings.ServerSettings explicitly.

  5. def cachedHostConnectionPool[T](host: String, port: Int = 80, settings: ConnectionPoolSettings = defaultConnectionPoolSettings, log: LoggingAdapter = system.log): Flow[(HttpRequest, T), (Try[HttpResponse], T), HostConnectionPool]

    Returns a akka.stream.scaladsl.Flow which dispatches incoming HTTP requests to the per-ActorSystem pool of outgoing HTTP connections to the given target host endpoint.

    Returns a akka.stream.scaladsl.Flow which dispatches incoming HTTP requests to the per-ActorSystem pool of outgoing HTTP connections to the given target host endpoint. For every ActorSystem, target host and pool configuration a separate connection pool is maintained. The HTTP layer transparently manages idle shutdown and restarting of connections pools as configured. The returned akka.stream.scaladsl.Flow instances therefore remain valid throughout the lifetime of the application.

    The internal caching logic guarantees that there will never be more than a single pool running for the given target host endpoint and configuration (in this ActorSystem).

    Since the underlying transport usually comprises more than a single connection the produced flow might generate responses in an order that doesn't directly match the consumed requests. For example, if two requests A and B enter the flow in that order the response for B might be produced before the response for A. In order to allow for easy response-to-request association the flow takes in a custom, opaque context object of type T from the application which is emitted together with the corresponding response.

    To configure additional settings for the pool (and requests made using it), use the akka.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

  6. def cachedHostConnectionPoolHttps[T](host: String, port: Int = 443, connectionContext: HttpsConnectionContext = defaultClientHttpsContext, settings: ConnectionPoolSettings = defaultConnectionPoolSettings, log: LoggingAdapter = system.log): Flow[(HttpRequest, T), (Try[HttpResponse], T), HostConnectionPool]

    Same as #cachedHostConnectionPool but for encrypted (HTTPS) connections.

    Same as #cachedHostConnectionPool but for encrypted (HTTPS) connections.

    If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for encryption on the connections.

    To configure additional settings for the pool (and requests made using it), use the akka.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

  7. def clientLayer(hostHeader: Host, settings: ClientConnectionSettings, log: LoggingAdapter = system.log): ClientLayer

    Constructs a akka.http.scaladsl.Http.ClientLayer stage using the given akka.http.scaladsl.settings.ClientConnectionSettings.

  8. def clientLayer(hostHeader: Host): ClientLayer

    Constructs a akka.http.scaladsl.Http.ClientLayer stage using the configured default akka.http.scaladsl.settings.ClientConnectionSettings, configured using the akka.http.client config section.

  9. def createClientHttpsContext(sslConfig: AkkaSSLConfig): HttpsConnectionContext
    Definition Classes
    DefaultSSLContextCreation
  10. def createDefaultClientHttpsContext(): HttpsConnectionContext
    Definition Classes
    DefaultSSLContextCreation
  11. def createServerHttpsContext(sslConfig: AkkaSSLConfig): HttpsConnectionContext
    Definition Classes
    DefaultSSLContextCreation
  12. def defaultClientHttpsContext: HttpsConnectionContext

    Gets the current default client-side HttpsConnectionContext.

    Gets the current default client-side HttpsConnectionContext. Defaults used here can be configured using ssl-config or the context can be replaced using setDefaultClientHttpsContext

  13. def defaultServerHttpContext: ConnectionContext

    Gets the current default server-side ConnectionContext – defaults to plain HTTP.

    Gets the current default server-side ConnectionContext – defaults to plain HTTP. Can be modified using setDefaultServerHttpContext, and will then apply for servers bound after that call has completed.

  14. def newHostConnectionPool[T](host: String, port: Int = 80, settings: ConnectionPoolSettings = defaultConnectionPoolSettings, log: LoggingAdapter = system.log)(implicit fm: Materializer): Flow[(HttpRequest, T), (Try[HttpResponse], T), HostConnectionPool]

    Starts a new connection pool to the given host and configuration and returns a akka.stream.scaladsl.Flow which dispatches the requests from all its materializations across this pool.

    Starts a new connection pool to the given host and configuration and returns a akka.stream.scaladsl.Flow which dispatches the requests from all its materializations across this pool. While the started host connection pool internally shuts itself down automatically after the configured idle timeout it will spin itself up again if more requests arrive from an existing or a new client flow materialization. The returned flow therefore remains usable for the full lifetime of the application.

    Since the underlying transport usually comprises more than a single connection the produced flow might generate responses in an order that doesn't directly match the consumed requests. For example, if two requests A and B enter the flow in that order the response for B might be produced before the response for A. In order to allow for easy response-to-request association the flow takes in a custom, opaque context object of type T from the application which is emitted together with the corresponding response.

    To configure additional settings for the pool (and requests made using it), use the akka.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

  15. def newHostConnectionPoolHttps[T](host: String, port: Int = 443, connectionContext: HttpsConnectionContext = defaultClientHttpsContext, settings: ConnectionPoolSettings = defaultConnectionPoolSettings, log: LoggingAdapter = system.log)(implicit fm: Materializer): Flow[(HttpRequest, T), (Try[HttpResponse], T), HostConnectionPool]

    Same as #newHostConnectionPool but for encrypted (HTTPS) connections.

    Same as #newHostConnectionPool but for encrypted (HTTPS) connections.

    If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for encryption on the connections.

    To configure additional settings for the pool (and requests made using it), use the akka.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

  16. def outgoingConnection(host: String, port: Int = 80, localAddress: Option[InetSocketAddress] = None, settings: ClientConnectionSettings = ClientConnectionSettings(system), log: LoggingAdapter = system.log): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Creates a akka.stream.scaladsl.Flow representing a prospective HTTP client connection to the given endpoint.

    Creates a akka.stream.scaladsl.Flow representing a prospective HTTP client connection to the given endpoint. Every materialization of the produced flow will attempt to establish a new outgoing connection.

    To configure additional settings for requests made using this method, use the akka.http.client config section or pass in a akka.http.scaladsl.settings.ClientConnectionSettings explicitly.

  17. def outgoingConnectionHttps(host: String, port: Int = 443, connectionContext: HttpsConnectionContext = defaultClientHttpsContext, localAddress: Option[InetSocketAddress] = None, settings: ClientConnectionSettings = ClientConnectionSettings(system), log: LoggingAdapter = system.log): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Same as #outgoingConnection but for encrypted (HTTPS) connections.

    Same as #outgoingConnection but for encrypted (HTTPS) connections.

    If an explicit HttpsConnectionContext is given then it rather than the configured default HttpsConnectionContext will be used for encryption on the connection.

    To configure additional settings for requests made using this method, use the akka.http.client config section or pass in a akka.http.scaladsl.settings.ClientConnectionSettings explicitly.

  18. def outgoingConnectionUsingContext(host: String, port: Int, connectionContext: ConnectionContext, settings: ClientConnectionSettings = ClientConnectionSettings(system), log: LoggingAdapter = system.log): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Similar to outgoingConnection but allows to specify a user-defined context to run the connection on.

    Similar to outgoingConnection but allows to specify a user-defined context to run the connection on.

    Depending on the kind of ConnectionContext the implementation will add TLS between the given transport and the HTTP implementation

    To configure additional settings for requests made using this method, use the akka.http.client config section or pass in a akka.http.scaladsl.settings.ClientConnectionSettings explicitly.

  19. def serverLayer(settings: ServerSettings = ServerSettings(system), remoteAddress: Option[InetSocketAddress] = None, log: LoggingAdapter = system.log, isSecureConnection: Boolean = false): ServerLayer

    Constructs a akka.http.scaladsl.Http.ServerLayer stage using the given akka.http.scaladsl.settings.ServerSettings.

    Constructs a akka.http.scaladsl.Http.ServerLayer stage using the given akka.http.scaladsl.settings.ServerSettings. The returned akka.stream.scaladsl.BidiFlow isn't reusable and can only be materialized once. The remoteAddress, if provided, will be added as a header to each akka.http.scaladsl.model.HttpRequest this layer produces if the akka.http.server.remote-address-header configuration option is enabled.

  20. def setDefaultClientHttpsContext(context: HttpsConnectionContext): Unit

    Sets the default client-side HttpsConnectionContext.

  21. def setDefaultServerHttpContext(context: ConnectionContext): Unit

    Sets the default server-side ConnectionContext.

    Sets the default server-side ConnectionContext. If it is an instance of HttpsConnectionContext then the server will be bound using HTTPS.

  22. def shutdownAllConnectionPools(): Future[Unit]

    Triggers an orderly shutdown of all host connections pools currently maintained by the akka.actor.ActorSystem.

    Triggers an orderly shutdown of all host connections pools currently maintained by the akka.actor.ActorSystem. The returned future is completed when all pools that were live at the time of this method call have completed their shutdown process.

    If existing pool client flows are re-used or new ones materialized concurrently with or after this method call the respective connection pools will be restarted and not contribute to the returned future.

  23. def singleRequest(request: HttpRequest, connectionContext: HttpsConnectionContext = defaultClientHttpsContext, settings: ConnectionPoolSettings = defaultConnectionPoolSettings, log: LoggingAdapter = system.log): Future[HttpResponse]

    Fires a single akka.http.scaladsl.model.HttpRequest across the (cached) host connection pool for the request's effective URI to produce a response future.

    Fires a single akka.http.scaladsl.model.HttpRequest across the (cached) host connection pool for the request's effective URI to produce a response future.

    If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for setting up the HTTPS connection pool, if the request is targeted towards an https endpoint.

    Note that the request must have an absolute URI, otherwise the future will be completed with an error.

  24. def singleWebSocketRequest[T](request: WebSocketRequest, clientFlow: Flow[Message, Message, T], connectionContext: ConnectionContext = defaultClientHttpsContext, localAddress: Option[InetSocketAddress] = None, settings: ClientConnectionSettings = ClientConnectionSettings(system), log: LoggingAdapter = system.log)(implicit mat: Materializer): (Future[WebSocketUpgradeResponse], T)

    Runs a single WebSocket conversation given a Uri and a flow that represents the client side of the WebSocket conversation.

  25. val sslConfig: AkkaSSLConfig
    Definition Classes
    HttpExt → DefaultSSLContextCreation
  26. def superPool[T](connectionContext: HttpsConnectionContext = defaultClientHttpsContext, settings: ConnectionPoolSettings = defaultConnectionPoolSettings, log: LoggingAdapter = system.log): Flow[(HttpRequest, T), (Try[HttpResponse], T), NotUsed]

    Creates a new "super connection pool flow", which routes incoming requests to a (cached) host connection pool depending on their respective effective URIs.

    Creates a new "super connection pool flow", which routes incoming requests to a (cached) host connection pool depending on their respective effective URIs. Note that incoming requests must have an absolute URI.

    If an explicit ConnectionContext is given then it rather than the configured default ConnectionContext will be used for setting up HTTPS connection pools, if required.

    Since the underlying transport usually comprises more than a single connection the produced flow might generate responses in an order that doesn't directly match the consumed requests. For example, if two requests A and B enter the flow in that order the response for B might be produced before the response for A. In order to allow for easy response-to-request association the flow takes in a custom, opaque context object of type T from the application which is emitted together with the corresponding response.

    To configure additional settings for the pool (and requests made using it), use the akka.http.host-connection-pool config section or pass in a ConnectionPoolSettings explicitly.

  27. implicit val system: ExtendedActorSystem
    Definition Classes
    HttpExt → DefaultSSLContextCreation
  28. def validateAndWarnAboutLooseSettings(): Unit
    Definition Classes
    DefaultSSLContextCreation
  29. def webSocketClientFlow(request: WebSocketRequest, connectionContext: ConnectionContext = defaultClientHttpsContext, localAddress: Option[InetSocketAddress] = None, settings: ClientConnectionSettings = ClientConnectionSettings(system), log: LoggingAdapter = system.log): Flow[Message, Message, Future[WebSocketUpgradeResponse]]

    Constructs a flow that once materialized establishes a WebSocket connection to the given Uri.

    Constructs a flow that once materialized establishes a WebSocket connection to the given Uri.

    The layer is not reusable and must only be materialized once.

  30. def webSocketClientLayer(request: WebSocketRequest, settings: ClientConnectionSettings = ClientConnectionSettings(system), log: LoggingAdapter = system.log): WebSocketClientLayer

    Constructs a akka.http.scaladsl.Http.WebSocketClientLayer stage using the configured default akka.http.scaladsl.settings.ClientConnectionSettings, configured using the akka.http.client config section.

    Constructs a akka.http.scaladsl.Http.WebSocketClientLayer stage using the configured default akka.http.scaladsl.settings.ClientConnectionSettings, configured using the akka.http.client config section.

    The layer is not reusable and must only be materialized once.