Type Members

1.  trait DefaultNettyServerComponents extends NettyServerComponents with api.BuiltInComponents with NoHttpFiltersComponents

   A convenient helper trait for constructing an NettyServer, for example:

   A convenient helper trait for constructing an NettyServer, for example:

   val components = new DefaultNettyServerComponents {
     override lazy val router = {
       case GET(p"/") => Action(parse.json) { body =>
         Ok("Hello")
       }
     }
   }
   val server = components.server

2.  trait DefaultPekkoHttpServerComponents extends PekkoHttpServerComponents with api.BuiltInComponents with NoHttpFiltersComponents

   A convenient helper trait for constructing an PekkoHttpServer, for example:

   A convenient helper trait for constructing an PekkoHttpServer, for example:

   val components = new DefaultPekkoHttpServerComponents {
     override lazy val router = {
       case GET(p"/") => Action(parse.json) { body =>
         Ok("Hello")
       }
     }
   }
   val server = components.server

3.  final class DevServerStart extends AnyRef

   Annotations

   @InternalApi()

4.  class NettyServer extends Server

   creates a Server implementation based Netty

5.  trait NettyServerComponents extends ServerComponents

   Cake for building a simple Netty server.

6.  class NettyServerProvider extends ServerProvider

   The Netty server provider

7.  sealed trait NettyTransport extends AnyRef
8.  class PekkoHttpServer extends Server

   Starts a Play server using Pekko HTTP.

9.  trait PekkoHttpServerComponents extends ServerComponents

   Components for building a simple Pekko HTTP Server.

10.  class PekkoHttpServerProvider extends ServerProvider

    Knows how to create an PekkoHttpServer.

11.  class RealServerProcess extends ServerProcess

    A ServerProcess that wraps a real JVM process.

    A ServerProcess that wraps a real JVM process. Calls have a real effect on the JVM, e.g. exit calls System.exit.

12.  final class SelfSignedSSLEngineProvider extends SSLEngineProvider

    An SSLEngineProvider which simply references the values in the SelfSigned object.

    An SSLEngineProvider which simply references the values in the SelfSigned object.

    Annotations

    @ApiMayChange()

13.  trait Server extends ReloadableServer

    Provides generic server behaviour for Play applications.

14.  trait ServerComponents extends AnyRef

    Components to create a Server instance.

15.  case class ServerConfig(rootDir: File, port: Option[Int], sslPort: Option[Int], address: String, mode: api.Mode, properties: Properties, configuration: Configuration) extends Product with Serializable

    Common configuration for servers such as NettyServer.

    Common configuration for servers such as NettyServer.

    rootDir

    The root directory of the server. Used to find default locations of files, log directories, etc.

    port

    The HTTP port to use.

    sslPort

    The HTTPS port to use.

    address

    The socket address to bind to.

    mode

    The run mode: dev, test or prod.

    configuration

    The configuration to use for loading the server. This is not the same as application configuration. This configuration is usually loaded from a server.conf file, whereas the application configuration is usually loaded from an application.conf file.

16.  final case class ServerEndpoint(description: String, scheme: String, host: String, port: Int, protocols: Set[String], serverAttribute: Option[String], ssl: Option[SSLContext]) extends Product with Serializable

    Contains information about which port and protocol can be used to connect to the server.

    Contains information about which port and protocol can be used to connect to the server. This class is used to abstract out the details of connecting to different backends and protocols. Most tests will operate the same no matter which endpoint they are connected to.

    Annotations

    @ApiMayChange()

17.  final case class ServerEndpoints(endpoints: Seq[ServerEndpoint]) extends Product with Serializable

    Wrapper for a sequence of ServerEndpoints.

    Wrapper for a sequence of ServerEndpoints. Has a few convenience methods. Also can be used as an implicit parameter to pass around server endpoint information.

    Annotations

    @ApiMayChange()

18.  class ServerListenException extends Exception

    This exception is thrown when the server is unable to listen on a port

19.  trait ServerProcess extends AnyRef

    Abstracts a JVM process so it can be mocked for testing or to isolate pseudo-processes within a VM.

    Abstracts a JVM process so it can be mocked for testing or to isolate pseudo-processes within a VM. Code using this class should use the methods in this class instead of methods like System.getProperties(), System.exit(), etc.

20.  trait ServerProvider extends AnyRef

    An object that knows how to obtain a server.

    An object that knows how to obtain a server. Instantiating a ServerProvider object should be fast and side-effect free. Any actual work that a ServerProvider needs to do should be delayed until the createServer method is called.

21.  final case class ServerStartException(message: String, cause: Option[Throwable] = None) extends Exception with Product with Serializable

    Indicates an issue with starting a server, e.g.

    Indicates an issue with starting a server, e.g. a problem reading its configuration.

22.  trait WebSocketable extends AnyRef