automorph.transport.http.server.VertxServer
See theVertxServer companion object
final case class VertxServer[Effect[_]](effectSystem: EffectSystem[Effect], port: Int, pathPrefix: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, vertxOptions: VertxOptions, httpServerOptions: HttpServerOptions, handler: RequestHandler[Effect, Context]) extends ServerTransport[Effect, Context]
Vert.x HTTP & WebSocket server message transport plugin.
Interprets HTTP request body as an RPC request and processes it using the specified RPC request handler.
- The response returned by the RPC request handler is used as HTTP response body.
- Processes only HTTP requests starting with specified URL path.
Type parameters
- Effect
-
effect type
Value parameters
- effectSystem
-
effect system plugin
- handler
-
RPC request handler
- httpServerOptions
-
HTTP server options
- 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
- vertxOptions
-
VertX options
- webSocket
-
support upgrading of HTTP connections to use WebSocket protocol if true, support HTTP only if false
Attributes
Members list
In this article