wvlet.airframe.http

This object was generated by sbt-buildinfo.

An empty RPCContext

gRPC error code definitions in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto

An entry point to access airframe-http functionalities

A base interface to implement http-server specific implementation

Common classifiers for HTTP client responses and exceptions in order to retry HTTP requests.

Used for passing the subsequent actions to HttpFilter and for defining the leaf action of request processing chain.

A base type to use classOf[HttpContextBase]. classOf[HttpContext[_, _, _] is not supported for higherkinded types

A filter interface to define actions for handling HTTP requests and responses.

Implementations of HttpFilter must wrap an exception occurred in the filter.apply(request, context) with F[_]

Interface for writing HTTP request/response logs

Http logger configuration

Http request/response data type definitions

Immutable case-insensitive MultiMap structure for representing Http headers, query parameters, etc.

HttpRequest[Req] wraps native request classes (e.g., okhttp's Response, finagle Response, etc.) so that we can implement common logic for various backends.

A type class to bridge the original requests and backend-specific request types (e.g., finagle, okhttp, etc.)

HttpResponse[Resp] wraps native response classes (e.g., okhttp's Response, finagle Response, etc.) so that we can implement common logic for various backends.

A type class to bridge the original response type and HttpResponse

A common trait for Http server implementations

Exception to report errors to client

HTTP status code collection.

A model class for RPC error message body. This message will be embedded to HTTP response body or gRPC trailer.

We need this class to avoid directly serde RPCException classes with airframe-codec, so that we can properly propagate the exact stack trace to the client.

RPCException provides a backend-independent (e.g., Finagle or gRPC) RPC error reporting mechanism. Create this exception with (RPCStatus code).toException(...) method.

If necessary, we can add more standard error_details parameter like https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto

RPC endpoint information

Define the standard RPC code that can be used for generic RPC service implementation.

This covers all gRPC statuses and have pre-defined mappings to HTTP status (4xx, 5xx) code.

If you need an application-specific error code, use an additional argument of the RPCError class.

A base class for defining standard RPC error codes

RPC status types

Router defines mappings from HTTP requests to Routes.

Router can be nested

• Router1 with Filter1
  • Router2: endpoints e1, e2
  • Router3: endpoints e3 with Filter2
• Router4: endpoints e4

From this router definition, the backend HTTP server specific implementation will build a mapping table like this: e1 -> Filter1 andThen process(e1) e2 -> Filter1 andThen process(e2) e3 -> Filter1 andThen Filter2 andThen process(e3) e4 -> process(e4)

Rx-based http server backend interface, which will be used for hiding the server implementation detailes between Netty, Finagle, and gRPC

RxHttpEndpoint is a terminal for processing requests and returns Rx[Response].

An RxHttpFilter is a filter for receiving the response from the endpoint via endpoint.apply(request), and transforming it into another Rx[Response].

An interface used for RPC clients (sbt-airframe) to discover the default router for the RPC endpoint.

Example usage:

 import wvlet.airframe.http._

 @RPC
 trait MyRPC {
   def hello(name:String) : String
 }

 object MyRPC extends RxRouterProvider {
   // sbt-airframe will generate an RPC client using this router
   override def router: RxRouter = RxRouter.of[MyRPC]
 }

Server address holder

Helper for returning static contents