AkkaServer

automorph.transport.http.server.AkkaServer

See theAkkaServer companion object

final case class AkkaServer[Effect[_]](effectSystem: EffectSystem[Effect], port: Int, pathPrefix: String, methods: Iterable[HttpMethod], mapException: Throwable => Int, readTimeout: FiniteDuration, serverSettings: ServerSettings, config: Config, guardianProps: Props, handler: RequestHandler[Effect, Context]) extends ServerTransport[Effect, Context]

Akka HTTP server transport plugin.

Interprets HTTP request body as an RPC request and processes it using the specified RPC request handler.

Type parameters

config: actor system configuration
effectSystem: effect system plugin
guardianProps: guardian actor properties
handler: RPC request handler
mapException: maps an exception to a corresponding HTTP status code
methods: allowed HTTP request methods
pathPrefix: HTTP URL path prefix, only requests starting with this path prefix are allowed
port: port to listen on for HTTP connections
readTimeout: request read timeout
serverSettings: HTTP server settings

Constructor: Creates and starts an Akka HTTP server with specified RPC request handler.
See also: Transport protocol

Library documentation

API
Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait ServerTransport[Effect, Context]

class Object

trait Matchable

class Any
Show all

Stops this server transport freeing the underlying resources.

Starts this server to process incoming requests.

Create a copy of this server transport with specified RPC request handler.

In this article

Generated with