Automorph
API
Generated with
Automorph/automorph/automorph.transport/automorph.transport.http/automorph.transport.http.server

automorph.transport.http.server

package automorph.transport.http.server

Members list

Type members

Classlikes

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.

Akka HTTP server 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.

Type parameters

Effect

effect type

Value 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

Attributes

Constructor

Creates and starts an Akka HTTP server with specified RPC request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ServerTransport[Effect, Context]
class Object
trait Matchable
class Any
Show all
object AkkaServer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
AkkaServer.type
final case class JettyServer[Effect[_]](effectSystem: EffectSystem[Effect], port: Int, pathPrefix: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, threadPool: ThreadPool, idleTimeout: FiniteDuration, maxFrameSize: Long, attributes: Map[String, String], handler: RequestHandler[Effect, Context]) extends ServerTransport[Effect, Context]

Jetty HTTP & WebSocket server message transport plugin.

Jetty 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

attributes

server attributes

effectSystem

effect system plugin

handler

RPC request handler

idleTimeout

idle WebSocket connection timeout

mapException

maps an exception to a corresponding HTTP status code

maxFrameSize

maximum WebSocket frame size

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

threadPool

thread pool

webSocket

support upgrading of HTTP connections to use WebSocket protocol if true, support HTTP only if false

Attributes

Constructor

Creates a Jetty HTTP server with specified RPC request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ServerTransport[Effect, Context]
class Object
trait Matchable
class Any
Show all
object JettyServer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class NanoServer[Effect[_]](effectSystem: EffectSystem[Effect], port: Int, pathPrefix: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, readTimeout: FiniteDuration, threads: Int) extends NanoWSD, ServerTransport[Effect, Context]

NanoHTTPD HTTP & WebSocket server message transport plugin.

NanoHTTPD 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

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

threads

number of request processing threads

webSocket

support upgrading of HTTP connections to use WebSocket protocol if true, support HTTP only if false

Attributes

Constructor

Creates a NanoHTTPD HTTP & WebSocket server with specified effect system.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ServerTransport[Effect, Context]
class NanoWSD
class NanoHTTPD
class Object
trait Matchable
class Any
Show all
object NanoServer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
NanoServer.type
final case class UndertowServer[Effect[_]](effectSystem: EffectSystem[Effect], port: Int, pathPrefix: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, builder: Builder, handler: RequestHandler[Effect, Context]) extends ServerTransport[Effect, Context]

Undertow HTTP & WebSocket server message transport plugin.

Undertow 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

builder

Undertow builder

effectSystem

effect system plugin

handler

RPC request andler

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

webSocket

support upgrading of HTTP connections to use WebSocket protocol if true, support HTTP only if false

Attributes

Constructor

Creates an Undertow HTTP & WebSocket server with specified effect system RPC request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ServerTransport[Effect, Context]
class Object
trait Matchable
class Any
Show all
object UndertowServer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

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

Constructor

Creates an Vert.x HTTP & WebSocket server with specified RPC request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ServerTransport[Effect, Context]
class Object
trait Matchable
class Any
Show all
object VertxServer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with