Class/Object

play.core.server

AkkaHttpServer

Related Docs: object AkkaHttpServer | package server

Permalink

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)

    Permalink
  2. new AkkaHttpServer(config: ServerConfig, applicationProvider: ApplicationProvider, actorSystem: ActorSystem, materializer: Materializer, stopHook: () ⇒ Future[_])

    Permalink
    Annotations
    @deprecated
    Deprecated

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val akkaHttpConfig: Config

    Permalink

    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

    Permalink
    Definition Classes
    AkkaHttpServerServer
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createAkkaHttpConfig(): Config

    Permalink

    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 createParserSettings(): ParserSettings

    Permalink

    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
  10. def createServerSettings(port: Int, connectionContext: ConnectionContext, secure: Boolean): ServerSettings

    Permalink

    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
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. def httpPort: Option[Int]

    Permalink

    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
    AkkaHttpServerServer
  17. def httpsPort: Option[Int]

    Permalink

    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
    AkkaHttpServerServer
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. lazy val mainAddress: InetSocketAddress

    Permalink
    Definition Classes
    AkkaHttpServer → ReloadableServer
  20. def mode: api.Mode

    Permalink
    Definition Classes
    AkkaHttpServerServer
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. val parserSettings: ParserSettings

    Permalink

    Play's parser settings for Akka HTTP.

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

    Attributes
    protected
  25. def reload(): Unit

    Permalink
    Definition Classes
    Server → ReloadableServer
  26. def remoteAddressOfRequest(req: HttpRequest): InetSocketAddress

    Permalink
  27. def stop(): Unit

    Permalink
    Definition Classes
    AkkaHttpServerServer → ReloadableServer
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

    Permalink
    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)]

    Permalink

    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