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

automorph.transport.http.endpoint

package automorph.transport.http.endpoint

Members list

Type members

Classlikes

final case class AkkaHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], mapException: Throwable => Int, readTimeout: FiniteDuration, handler: RequestHandler[Effect, Context]) extends EndpointTransport[Effect, Context, Route]

Akka HTTP endpoint message transport plugin.

Akka HTTP endpoint message transport plugin.

Interprets HTTP request body as a RPC request and processes it with the specified RPC handler.

  • The response returned by the RPC handler is used as HTTP response body.

Type parameters

Effect

effect type

Value parameters

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

readTimeout

HTTP request read timeout

Attributes

Constructor

Creates an Akka HTTP endpoint message transport plugin with specified effect system and request handler.

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FinagleHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends Service[Request, Response], EndpointTransport[Effect, Context, Service[Request, Response]]

Finagle HTTP endpoint message transport plugin.

Finagle HTTP endpoint message transport plugin.

Interprets HTTP request body as a RPC request and processes it with the specified RPC handler.

  • The response returned by the RPC handler is used as HTTP response body.

Type parameters

Effect

effect type

Value parameters

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

Attributes

Constructor

Creates an Finagle HTTP endpoint message transport plugin with specified effect system and request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Closable
trait Request => Future[Response]
class Object
trait Matchable
class Any
Show all
object FinagleHttpEndpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JettyHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends HttpServlet, EndpointTransport[Effect, Context, HttpServlet]

Jetty HTTP endpoint message transport plugin.

Jetty HTTP endpoint message transport plugin.

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

  • The response returned by the RPC handler is used as HTTP response body.

Type parameters

Effect

effect type

Value parameters

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

Attributes

Constructor

Creates an Jetty HTTP endpoint message transport plugin with specified effect system and request handler.

See also
Companion
object
Supertypes
trait Product
trait Equals
class HttpServlet
trait Serializable
trait Servlet
class Object
trait Matchable
class Any
Show all
object JettyHttpEndpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JettyWebSocketEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends WebSocketAdapter, JettyWebSocketCreator, EndpointTransport[Effect, Context, WebSocketAdapter]

Jetty WebSocket endpoint message transport plugin.

Jetty WebSocket endpoint message transport plugin.

Interprets WebSocket request message as an RPC request and processes it using the specified RPC request handler.

  • The response returned by the RPC request handler is used as WebSocket response message.

Type parameters

Effect

effect type

Value parameters

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

Attributes

Constructor

Creates an Jetty HTTP endpoint message transport plugin with specified effect system and request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JettyWebSocketEndpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TapirHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], pathPrefix: String, method: Option[HttpMethod], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends EndpointTransport[Effect, Context, Full[Unit, Unit, Request, Unit, (Array[Byte], StatusCode), Any, Effect]]

Tapir HTTP endpoint message transport plugin.

Tapir HTTP endpoint 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.

Type parameters

Effect

effect type

Value parameters

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

method

allowed HTTP method, all methods are allowed if empty

pathPrefix

HTTP URL path prefix, only requests starting with this path prefix are allowed

Attributes

Constructor

Creates a Tapir HTTP endpoint message transport plugin with specified effect system and request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait EndpointTransport[Effect, Context, Full[Unit, Unit, Request, Unit, (Array[Byte], StatusCode), Any, Effect]]
class Object
trait Matchable
class Any
Show all
object TapirHttpEndpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class UndertowHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends HttpHandler, EndpointTransport[Effect, Context, HttpHandler]

Undertow HTTP endpoint transport plugin.

Undertow HTTP endpoint 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

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

Attributes

Constructor

Creates an Undertow HTTP endpoint message transport plugin with specified effect system and request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpHandler
class Object
trait Matchable
class Any
Show all
object UndertowHttpEndpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VertxHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends Handler[HttpServerRequest], EndpointTransport[Effect, Context, Handler[HttpServerRequest]]

Vert.x HTTP endpoint message transport plugin.

Vert.x HTTP endpoint 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.

Type parameters

Effect

effect type

Value parameters

effectSystem

effect system plugin

handler

RPC request handler

mapException

maps an exception to a corresponding HTTP status code

Attributes

Constructor

Creates a Vert.x HTTP endpoint message transport plugin with specified effect system and request handler.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VertxHttpEndpoint

Attributes

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