class AkkaHttpServer extends Server

Starts a Play server using Akka HTTP.

Source
AkkaHttpServer.scala
Linear Supertypes
Server, ReloadableServer, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AkkaHttpServer
  2. Server
  3. ReloadableServer
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AkkaHttpServer(context: Context)
  2. new AkkaHttpServer(config: ServerConfig, applicationProvider: ApplicationProvider, actorSystem: ActorSystem, materializer: Materializer, stopHook: () ⇒ Future[_])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.14) Use new AkkaHttpServer(Context) instead

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. val akkaHttpConfig: Config

    Play's configuration for the Akka HTTP server.

    Play's configuration for the Akka HTTP server. Initialized by a call to createAkkaHttpConfig().

    Note that the rest of the ActorSystem outside Akka HTTP is initialized by the configuration in config.

    Attributes
    protected
  5. def applicationProvider: ApplicationProvider
    Definition Classes
    AkkaHttpServer → Server
  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 createAkkaHttpConfig(): Config

    Creates the configuration used to initialize the Akka HTTP subsystem.

    Creates the configuration used to initialize the Akka HTTP subsystem. By default this uses the ActorSystem's configuration, with an additional setting patched in to enable or disable HTTP/2.

    Attributes
    protected
  9. def createClientAuth(): Option[TLSClientAuth]

    Creates AkkaHttp TLSClientAuth

    Creates AkkaHttp TLSClientAuth

    Attributes
    protected
  10. def createParserSettings(): ParserSettings

    Called by Play when creating its Akka HTTP parser settings.

    Called by Play when creating its Akka HTTP parser settings. Result stored in parserSettings.

    Attributes
    protected
  11. def createServerSettings(port: Int, connectionContext: ConnectionContext, secure: Boolean): ServerSettings

    Create Akka HTTP settings for a given port binding.

    Create Akka HTTP settings for a given port binding.

    Called by Play when binding a handler to a server port. Will be called once per port. Called by the createServerBinding() method.

    Attributes
    protected
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def httpPort: Option[Int]

    Returns the HTTP port of the server.

    Returns the HTTP port of the server.

    This is useful when the port number has been automatically selected (by setting a port number of 0).

    returns

    The HTTP port the server is bound to, if the HTTP connector is enabled.

    Definition Classes
    AkkaHttpServer → Server
  18. def httpsPort: Option[Int]

    Returns the HTTPS port of the server.

    Returns the HTTPS port of the server.

    This is useful when the port number has been automatically selected (by setting a port number of 0).

    returns

    The HTTPS port the server is bound to, if the HTTPS connector is enabled.

    Definition Classes
    AkkaHttpServer → Server
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. lazy val mainAddress: InetSocketAddress
    Definition Classes
    AkkaHttpServer → ReloadableServer
  21. def mode: api.Mode
    Definition Classes
    AkkaHttpServer → Server
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val parserSettings: ParserSettings

    Play's parser settings for Akka HTTP.

    Play's parser settings for Akka HTTP. Initialized by a call to createParserSettings().

    Attributes
    protected
  26. def reload(): Unit
    Definition Classes
    Server → ReloadableServer
  27. def remoteAddressOfRequest(req: HttpRequest): InetSocketAddress
  28. def stop(): Unit
    Definition Classes
    AkkaHttpServer → Server → ReloadableServer
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

  1. def executeAction(request: HttpRequest, taggedRequestHeader: RequestHeader, requestBodySource: Either[ByteString, Source[ByteString, _]], action: EssentialAction, errorHandler: HttpErrorHandler): Future[HttpResponse]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.10) This method is an internal API and should not be public

  2. def getHandlerFor(request: RequestHeader): Either[Future[Result], (RequestHeader, Handler, api.Application)]

    Try to get the handler for a request and return it as a Right.

    Try to get the handler for a request and return it as a Right. If we can't get the handler for some reason then return a result immediately as a Left. Reasons to return a Left value:

    - If there's a "web command" installed that intercepts the request. - If we fail to get the Application from the applicationProvider, i.e. if there's an error loading the application. - If an exception is thrown.

    NOTE: This will use the ApplicationProvider of the server to get the application instance. Use Server.getHandlerFor(request, provider) to pass a specific application instance

    Definition Classes
    Server
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.13) Use Server.getHandlerFor instead

Inherited from Server

Inherited from ReloadableServer

Inherited from AnyRef

Inherited from Any

Ungrouped