Trait/Object

io.youi.client

HttpClient

Related Docs: object HttpClient | package client

Permalink

trait HttpClient extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def connectionPool: ConnectionPool

    Permalink
  2. abstract def content2String(content: Content): String

    Permalink
    Attributes
    protected
  3. abstract def defaultInterceptor: Interceptor

    Permalink
  4. abstract def defaultRetries: Int

    Permalink
  5. abstract def defaultRetryDelay: FiniteDuration

    Permalink
  6. abstract def dns: DNS

    Permalink
  7. abstract def implementation(request: HttpRequest): Future[HttpResponse]

    Permalink
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def call[Response](url: URL, method: Method = Method.Get, headers: Headers = Headers.empty, errorHandler: ErrorHandler[Response] = defaultErrorHandler[Response], retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay, interceptor: Interceptor = defaultInterceptor)(implicit decoder: Decoder[Response]): Future[Response]

    Permalink

    Builds on the send method by supporting basic restful calls that calls a URL and returns a case class as the response.

    Builds on the send method by supporting basic restful calls that calls a URL and returns a case class as the response.

    Response

    the response type

    url

    the URL of the endpoint

    headers

    the headers if any to provide

    errorHandler

    error handling support if the response status is not Success

    decoder

    circe decoding of the Response

    returns

    Future[Response]

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def defaultErrorHandler[Response]: ErrorHandler[Response]

    Permalink

    Default error handler for restful bad response statuses.

    Default error handler for restful bad response statuses.

    Response

    the type of response

    returns

    throws a RuntimeException when an error occurs

    Attributes
    protected
  8. def dropNullValues: Boolean

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. lazy val printer: Printer

    Permalink
    Attributes
    protected
  19. def restful[Request, Response](url: URL, request: Request, headers: Headers = Headers.empty, errorHandler: ErrorHandler[Response] = defaultErrorHandler[Response], method: Method = Method.Post, processor: (Json) ⇒ Json = (json: Json) => json, retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay, interceptor: Interceptor = defaultInterceptor)(implicit encoder: Encoder[Request], decoder: Decoder[Response]): Future[Response]

    Permalink

    Builds on the send method by supporting basic restful calls that take a case class as the request and returns a case class as the response.

    Builds on the send method by supporting basic restful calls that take a case class as the request and returns a case class as the response.

    Request

    the request type

    Response

    the response type

    url

    the URL of the endpoint

    request

    the request instance

    headers

    the headers if any to provide

    errorHandler

    error handling support if the response status is not Success

    encoder

    circe encoding of the Request

    decoder

    circe decoding of the Response

    returns

    Future[Response]

  20. final def send(request: HttpRequest, retry: Int = defaultRetries, retryDelay: FiniteDuration = defaultRetryDelay, interceptor: Interceptor = defaultInterceptor): Future[HttpResponse]

    Permalink

    Sends an HttpRequest and receives an asynchronous HttpResponse future.

    Sends an HttpRequest and receives an asynchronous HttpResponse future.

    request

    the request to send

    retry

    the number of times to retry a failed request. This defaults to zero as most requests are not idempotent and calling multiple times can cause side-effects

    retryDelay

    if a failure occurs and a retry must occur, how long to wait until retrying. This defaults to 5.0 seconds

    interceptor

    specifies an interceptor to work with requests and responses. Defaults to Interceptor.empty.

    returns

    Future[HttpResponse]

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped