package http

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. http
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package client
  2. package impl
  3. package internal
  4. package js

Type Members

  1. trait ChannelConfig extends AnyRef

    Contains only http channel related configurations in HttpClientConfig

  2. trait CompatApi extends AnyRef

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

  3. trait Endpoint extends Annotation
    Annotations
    @Retention() @Target()
  4. sealed abstract class GrpcStatus extends PackSupport
  5. trait HttpBackend[Req, Resp, F[_]] extends AnyRef

    A base interface to implement http-server specific implementation

  6. trait HttpClient[F[_], Req, Resp] extends HttpClientBase[F, Req, Resp] with 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.)

  7. trait HttpClientBase[F[_], Req, Resp] extends AnyRef

  8. case class HttpClientConfig(backend: HttpClientBackend = compat.defaultHttpClientBackend, requestFilter: (Request) => Request = identity, rpcEncoding: RPCEncoding = RPCEncoding.JSON, retryContext: RetryContext = compat.defaultHttpClientBackend.defaultRequestRetryer, codecFactory: MessageCodecFactory = MessageCodecFactory.defaultFactoryForJSON, circuitBreaker: CircuitBreaker = CircuitBreaker.withConsecutiveFailures(5), connectTimeout: Duration = Duration(90, TimeUnit.SECONDS), readTimeout: Duration = Duration(90, TimeUnit.SECONDS), executionContextProvider: (HttpClientConfig) => ExecutionContext = _ => compat.defaultExecutionContext, clientFilter: ClientFilter = ClientFilter.identity, rxConverter: (Future[_]) => RxStream[_] = (f: Future[_]) => // TODO: This execution context needs to reference a global one if we need to use it in Scala JVM Rx.future(f)(compat.defaultExecutionContext)) extends ChannelConfig with Product with Serializable

  9. class HttpClientException extends Exception

  10. case class HttpClientMaxRetryException(response: HttpResponse[_], retryContext: RetryContext, cause: Throwable) extends HttpClientException with Product with Serializable
  11. trait HttpContext[Req, Resp, F[_]] extends HttpContextBase

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

  12. trait HttpContextBase extends AnyRef

    A base type to use classOf[HttpContextBase].

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

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

  14. trait HttpFilterType extends AnyRef
  15. trait HttpMessage[Raw] extends HttpMessageBase[Raw]
  16. trait HttpMessageBase[Raw] extends AnyRef
  17. case class HttpMultiMap(underlying: Map[String, Any] = Map.empty) extends Product with Serializable

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

  18. case class HttpMultiMapEntry(key: String, value: String) extends Product with Serializable
  19. 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.

  20. trait HttpRequestAdapter[Req] extends AnyRef

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

  21. 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.

  22. trait HttpResponseAdapter[Resp] extends AnyRef

    A type class to bridge the original response type and HttpResponse

  23. class HttpResponseBodyCodec[Resp] extends MessageCodec[HttpResponse[_]]

  24. class HttpServerException extends Exception with HttpServerExceptionBase

    Exception to report errors to client

  25. trait HttpServerExceptionBase extends AnyRef

  26. class HttpStatus extends PackSupport
  27. trait HttpSyncClient[Req, Resp] extends HttpSyncClientBase[Req, Resp] with AutoCloseable

    A synchronous HTTP Client interface

  28. class HttpSyncClientAdapter[F[_], Req, Resp] extends HttpSyncClientAdapterBase[F, Req, Resp]

    A synchronous HttpClient that awaits responses.

  29. abstract class HttpSyncClientAdapterBase[F[_], Req, Resp] extends HttpSyncClient[Req, Resp]
  30. trait HttpSyncClientBase[Req, Resp] extends AnyRef
  31. trait RPC extends Annotation
    Annotations
    @Retention() @Target()
  32. trait RPCContext extends AnyRef
  33. sealed trait RPCEncoding extends AnyRef

  34. case class RPCErrorMessage(code: Int = RPCStatus.UNKNOWN_I1.code, codeName: String = RPCStatus.UNKNOWN_I1.name, message: String = "", stackTrace: Option[Seq[GenericStackTraceElement]] = None, cause: Option[Throwable] = None, appErrorCode: Option[Int] = None, metadata: Map[String, Any] = Map.empty) extends Product with Serializable

    A model class for RPC error message body.

    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.

  35. case class RPCException(status: RPCStatus = RPCStatus.INTERNAL_ERROR_I0, message: String = "", cause: Option[Throwable] = None, appErrorCode: Option[Int] = None, metadata: Map[String, Any] = Map.empty) extends Exception with Product with Serializable

    RPCException provides a backend-independent (e.g., Finagle or gRPC) RPC error reporting mechanism.

    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

  36. case class RPCMethod(path: String, rpcInterfaceName: String, methodName: String, requestSurface: Surface, responseSurface: Surface) extends Product with Serializable

    RPC endpoint information

  37. sealed abstract class RPCStatus extends PackSupport

    A base class for defining standard RPC error codes

  38. sealed trait RPCStatusType extends PackSupport

    RPC status types

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

    Server address holder

  40. trait description extends Annotation
    Annotations
    @Retention() @Target()

Value Members

  1. val compat: CompatApi
  2. case object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  3. object EmptyRPCContext extends RPCContext

    An empty RPCContext

  4. object GrpcStatus

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

  5. object Http

    An entry point to access airframe-http functionalities

  6. object HttpBackend
  7. object HttpClient extends LogSupport
  8. object HttpClientConfig extends Serializable
  9. object HttpClientException extends LogSupport

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

  10. object HttpContext
  11. object HttpFilter
  12. object HttpHeader
  13. object HttpMessage

    Http request/response data type definitions

  14. object HttpMethod
  15. object HttpMultiMap extends Serializable
  16. object HttpMultiMapCodec extends MessageCodec[HttpMultiMap]

  17. object HttpStatus

    HTTP status code collection.

  18. object RPCContext
  19. object RPCEncoding
  20. object RPCException extends Serializable
  21. object RPCStatus

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

    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.

  22. object RPCStatusType
  23. object ServerAddress extends LogSupport

Inherited from AnyRef

Inherited from Any

Ungrouped