http

Type Members

1. trait CompatApi extends AnyRef

   

   An interface for using different implementation betweeen Scala JVM and Scala.js

2. class Endpoint extends Annotation with Annotation with ClassfileAnnotation

   

3. trait HttpBackend[Req, Resp, F[_]] extends AnyRef

   

   A base interface to implement http-server specific implementation

4. trait HttpClient[F[_], Req, Resp] extends AutoCloseable

   

   Asynchronous HTTP Client interface

   Asynchronous HTTP Client interface

   F

   An abstraction for Future type (e.g., Resolves the differences between Twitter Future, Scala Future, etc.)

5. trait HttpClientBackend extends AnyRef

   

6. case class HttpClientConfig(backend: HttpClientBackend = Compat.defaultHttpClientBackend, requestFilter: (Request) ⇒ Request = identity, retryContext: RetryContext = ..., codecFactory: MessageCodecFactory = ...) extends Product with Serializable

   

7. class HttpClientException extends Exception

   

8. case class HttpClientMaxRetryException(response: HttpResponse[_], retryContext: RetryContext, cause: Throwable) extends HttpClientException with Product with Serializable

   

9. trait HttpContext[Req, Resp, F[_]] extends AnyRef

   

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

10. trait HttpFilter[Req, Resp, F[_]] extends HttpFilterType

    

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

    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[_]

11. trait HttpFilterType extends AnyRef

    

12. trait HttpMessage[Raw] extends AnyRef

    

13. case class HttpMultiMap(underlying: Map[String, Any] = Map.empty) extends Product with Serializable

    

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

14. case class HttpMultiMapEntry(key: String, value: String) extends Product with Serializable

    

15. trait HttpRequest[Req] extends AnyRef

    

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

16. trait HttpRequestAdapter[Req] extends AnyRef

    

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

17. trait HttpResponse[Resp] extends AnyRef

    

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

18. trait HttpResponseAdapter[Resp] extends AnyRef

    

    A type class to bridge the original response type and HttpResponse

19. case class HttpServerException(response: Response, cause: Throwable) extends Exception with HttpMessage[HttpServerException] with Product with Serializable

    

    Exception to report errors to client

20. class HttpStatus extends AnyRef

    

21. trait HttpSyncClient[Req, Resp] extends AutoCloseable

    

    A synchronous HTTP Client interface

22. class HttpSyncClientAdapter[F[_], Req, Resp] extends HttpSyncClient[Req, Resp]

    

    A synchronous HttpClient that awaits responses.

23. class RPC extends Annotation with Annotation with ClassfileAnnotation

    

24. case class Router(surface: Option[Surface] = None, children: Seq[Router] = Seq.empty, localRoutes: Seq[Route] = Seq.empty, filterSurface: Option[Surface] = None, filterInstance: Option[HttpFilterType] = None) extends LogSupport with Product with Serializable

    

    Router defines mappings from HTTP requests to Routes.

    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)

25. case class ServerAddress(host: String, port: Int, scheme: String = "http") extends Product with Serializable

    

    Server address holder

26. case class StaticContent(resourcePaths: List[ResourceType] = List.empty) extends Product with Serializable