Class/Object

org.http4s.client

Client

Related Docs: object Client | package client

Permalink

final case class Client[F[_]](open: Kleisli[F, Request[F], DisposableResponse[F]], shutdown: F[Unit])(implicit F: MonadError[F, Throwable]) extends Product with Serializable

A Client submits Requests to a server and processes the Response.

open

a service to asynchronously return a DisposableResponse from a Request. This is a low-level operation intended for client implementations and middleware.

shutdown

an effect to shut down this Shutdown this client, closing any open connections and freeing resources

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Client(open: Kleisli[F, Request[F], DisposableResponse[F]], shutdown: F[Unit])(implicit F: MonadError[F, Throwable])

    Permalink

    open

    a service to asynchronously return a DisposableResponse from a Request. This is a low-level operation intended for client implementations and middleware.

    shutdown

    an effect to shut down this Shutdown this client, closing any open connections and freeing resources

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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def expect[A](s: String)(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

    Submits a GET request to the URI specified by the String and decodes the response on success.

    Submits a GET request to the URI specified by the String and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.

  8. def expect[A](uri: Uri)(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

    Submits a GET request to the specified URI and decodes the response on success.

    Submits a GET request to the specified URI and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.

  9. def expect[A](req: F[Request[F]])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

  10. def expect[A](req: Request[F])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

    Submits a request and decodes the response on success.

    Submits a request and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.

  11. def expectOr[A](s: String)(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

  12. def expectOr[A](uri: Uri)(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

  13. def expectOr[A](req: F[Request[F]])(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

  14. def expectOr[A](req: Request[F])(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

  15. def fetch[A](req: F[Request[F]])(f: (Response[F]) ⇒ F[A]): F[A]

    Permalink

    Submits a request, and provides a callback to process the response.

    Submits a request, and provides a callback to process the response.

    req

    An effect of the request to submit

    f

    A callback for the response to req. The underlying HTTP connection is disposed when the returned task completes. Attempts to read the response body afterward will result in an error.

    returns

    The result of applying f to the response to req

  16. def fetch[A](req: Request[F])(f: (Response[F]) ⇒ F[A]): F[A]

    Permalink

    Submits a request, and provides a callback to process the response.

    Submits a request, and provides a callback to process the response.

    req

    The request to submit

    f

    A callback for the response to req. The underlying HTTP connection is disposed when the returned task completes. Attempts to read the response body afterward will result in an error.

    returns

    The result of applying f to the response to req

  17. def fetchAs[A](req: F[Request[F]])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

    Submits a request and decodes the response, regardless of the status code.

    Submits a request and decodes the response, regardless of the status code. The underlying HTTP connection is closed at the completion of the decoding.

  18. def fetchAs[A](req: Request[F])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

    Submits a request and decodes the response, regardless of the status code.

    Submits a request and decodes the response, regardless of the status code. The underlying HTTP connection is closed at the completion of the decoding.

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. def get[A](s: String)(f: (Response[F]) ⇒ F[A]): F[A]

    Permalink

    Submits a request and decodes the response on success.

    Submits a request and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.

  21. def get[A](uri: Uri)(f: (Response[F]) ⇒ F[A]): F[A]

    Permalink

    Submits a GET request, and provides a callback to process the response.

    Submits a GET request, and provides a callback to process the response.

    uri

    The URI to GET

    f

    A callback for the response to a GET on uri. The underlying HTTP connection is disposed when the returned task completes. Attempts to read the response body afterward will result in an error.

    returns

    The result of applying f to the response to req

  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. val open: Kleisli[F, Request[F], DisposableResponse[F]]

    Permalink

    a service to asynchronously return a DisposableResponse from a Request.

    a service to asynchronously return a DisposableResponse from a Request. This is a low-level operation intended for client implementations and middleware.

  28. val shutdown: F[Unit]

    Permalink

    an effect to shut down this Shutdown this client, closing any open connections and freeing resources

  29. def shutdownNow()(implicit F: Effect[F]): Unit

    Permalink

    Shuts this client down, and blocks until complete.

  30. def status(req: F[Request[F]]): F[Status]

    Permalink

    Submits a request and returns the response status

  31. def status(req: Request[F]): F[Status]

    Permalink

    Submits a request and returns the response status

  32. def streaming[A](req: F[Request[F]])(f: (Response[F]) ⇒ Stream[F, A]): Stream[F, A]

    Permalink

  33. def streaming[A](req: Request[F])(f: (Response[F]) ⇒ Stream[F, A]): Stream[F, A]

    Permalink

  34. def successful(req: F[Request[F]]): F[Boolean]

    Permalink

    Submits a request and returns true if and only if the response status is successful

  35. def successful(req: Request[F]): F[Boolean]

    Permalink

    Submits a request and returns true if and only if the response status is successful

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

    Permalink
    Definition Classes
    AnyRef

  37. def toHttpService: HttpService[F]

    Permalink

    Returns this client as an HttpService.

    Returns this client as an HttpService. It is the responsibility of callers of this service to run the response body to dispose of the underlying HTTP connection.

    This is intended for use in proxy servers. fetch, fetchAs, toKleisli, and streaming are safer alternatives, as their signatures guarantee disposal of the HTTP connection.

  38. def toKleisli[A](f: (Response[F]) ⇒ F[A]): Kleisli[F, Request[F], A]

    Permalink

    Returns this client as a Kleisli.

    Returns this client as a Kleisli. All connections created by this service are disposed on completion of callback task f.

    This method effectively reverses the arguments to fetch, and is preferred when an HTTP client is composed into a larger Kleisli function, or when a common response callback is used by many call sites.

  39. final def wait(): Unit

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

  40. final def wait(arg0: Long, arg1: Int): Unit

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

  41. final def wait(arg0: Long): Unit

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

Deprecated Value Members

  1. def getAs[A](s: String)(implicit d: EntityDecoder[F, A]): F[A]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.14) Use expect

  2. def getAs[A](uri: Uri)(implicit d: EntityDecoder[F, A]): F[A]

    Permalink

    Submits a GET request and decodes the response.

    Submits a GET request and decodes the response. The underlying HTTP connection is closed at the completion of the decoding.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.14) Use expect

  3. def prepAs[T](req: F[Request[F]])(implicit d: EntityDecoder[F, T]): F[T]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.14) Use expect

  4. def prepAs[A](req: Request[F])(implicit d: EntityDecoder[F, A]): F[A]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.14) Use expect

  5. def toService[A](f: (Response[F]) ⇒ F[A]): Service[F, Request[F], A]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use toKleisli

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped