class AkkaHttpServer extends Server
- Alphabetic
- By Inheritance
- AkkaHttpServer
- Server
- ReloadableServer
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new AkkaHttpServer(context: Context)
-
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
-
def
applicationProvider: ApplicationProvider
- Definition Classes
- AkkaHttpServer → Server
-
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
-
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
-
lazy val
mainAddress: InetSocketAddress
- Definition Classes
- AkkaHttpServer → ReloadableServer
-
def
mode: api.Mode
- Definition Classes
- AkkaHttpServer → Server
-
def
reload(): Unit
- Definition Classes
- Server → ReloadableServer
- def remoteAddressOfRequest(req: HttpRequest): InetSocketAddress
-
def
stop(): Unit
- Definition Classes
- AkkaHttpServer → Server → ReloadableServer
Deprecated Value Members
-
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
-
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 aLeft
. Reasons to return aLeft
value:- If there's a "web command" installed that intercepts the request. - If we fail to get the
Application
from theapplicationProvider
, 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