Object/Class

play.core.server

AkkaHttpServer

Related Docs: class AkkaHttpServer | package server

Permalink

object AkkaHttpServer extends ServerFromRouter

Creates an AkkaHttpServer from the given router:

val server = AkkaHttpServer.fromRouter(ServerConfig(port = Some(9002))) {
  case GET(p"/") => Action {
    Results.Ok("Hello")
  }
}

Or from a given router using BuiltInComponents:

val server = AkkaHttpServer.fromRouterWithComponents(ServerConfig(port = Some(9002))) { components =>
  import play.api.mvc.Results._
  import components.{ defaultActionBuilder => Action }
  {
    case GET(p"/") => Action {
      Ok("Hello")
    }
  }
}

Use this together with Sird Router.

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

Type Members

  1. final case class Context(config: ServerConfig, appProvider: ApplicationProvider, actorSystem: ActorSystem, materializer: Materializer, stopHook: () ⇒ Future[_]) extends Product with Serializable

    Permalink

    The values needed to initialize an AkkaHttpServer.

    The values needed to initialize an AkkaHttpServer.

    config

    Basic server configuration values.

    appProvider

    An object which can be queried to get an Application.

    actorSystem

    An ActorSystem that the server can use.

    stopHook

    A function that should be called by the server when it stops. This function can be used to close resources that are provided to the server.

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. object Context extends Serializable

    Permalink

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. def createServerFromRouter(serverConf: ServerConfig = ServerConfig())(routes: (ServerComponents with api.BuiltInComponents) ⇒ Router): Server

    Permalink
    Attributes
    protected
    Definition Classes
    AkkaHttpServer → ServerFromRouter

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. def fromApplication(application: api.Application, config: ServerConfig = ServerConfig()): AkkaHttpServer

    Permalink

    Create a Netty server from the given application and server configuration.

    Create a Netty server from the given application and server configuration.

    application

    The application.

    config

    The server configuration.

    returns

    A started Netty server, serving the application.

  12. def fromRouter(config: ServerConfig = ServerConfig())(routes: PartialFunction[RequestHeader, Handler]): AkkaHttpServer

    Permalink

    Creates a Server from the given router.

    Creates a Server from the given router.

    config

    the server configuration

    routes

    the routes definitions

    returns

    an AkkaHttpServer instance

    Definition Classes
    AkkaHttpServer → ServerFromRouter

  13. def fromRouterWithComponents(config: ServerConfig = ServerConfig())(routes: (api.BuiltInComponents) ⇒ PartialFunction[RequestHeader, Handler]): Server

    Permalink

    Creates a Server from the given router, using ServerComponents.

    Creates a Server from the given router, using ServerComponents.

    config

    the server configuration

    routes

    the routes definitions

    returns

    an AkkaHttpServer instance

    Definition Classes
    ServerFromRouter

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. implicit val provider: AkkaHttpServerProvider

    Permalink

    A ServerProvider for creating an AkkaHttpServer.

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

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

  24. final def wait(arg0: Long, arg1: Int): Unit

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

  25. final def wait(arg0: Long): Unit

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

Inherited from ServerFromRouter

Inherited from AnyRef

Inherited from Any

Ungrouped