Packages

trait Client[F[_]] extends AnyRef

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

Source
Client.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    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.

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

    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.

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

    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.

  5. abstract def expectOption[A](req: Request[F])(implicit d: EntityDecoder[F, A]): F[Option[A]]
  6. abstract def expectOptionOr[A](req: Request[F])(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[Option[A]]
  7. abstract def expectOr[A](s: String)(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
  8. abstract def expectOr[A](uri: Uri)(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
  9. abstract def expectOr[A](req: F[Request[F]])(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
  10. abstract def expectOr[A](req: Request[F])(onError: (Response[F]) ⇒ F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
  11. abstract def fetchAs[A](req: F[Request[F]])(implicit d: EntityDecoder[F, A]): F[A]

    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.

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

    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.

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

    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.

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

    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

  15. abstract def run(req: Request[F]): Resource[F, Response[F]]
  16. abstract def status(req: F[Request[F]]): F[Status]

    Submits a request and returns the response status

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

    Submits a request and returns the response status

  18. abstract def statusFromString(s: String): F[Status]

    Submits a GET request to the URI and returns the response status

  19. abstract def statusFromUri(uri: Uri): F[Status]

    Submits a GET request to the URI and returns the response status

  20. abstract def stream(req: Request[F]): Stream[F, Response[F]]

    Run the request as a stream.

    Run the request as a stream. The response lifecycle is equivalent to the returned Stream's.

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

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

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

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

  23. abstract def toHttpApp: HttpApp[F]

    Returns this client as an HttpApp.

    Returns this client as an HttpApp. 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. run, fetchAs, toKleisli, and streaming are safer alternatives, as their signatures guarantee disposal of the HTTP connection.

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

    Returns this client as a cats.data.Kleisli.

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

    This method effectively reverses the arguments to run followed by use, 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.

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

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.5) Use req.flatMap(run(_).use(f))

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

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.5) Use run(req).use(f)

  27. abstract def streaming[A](req: F[Request[F]])(f: (Response[F]) ⇒ Stream[F, A]): Stream[F, A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0-M4) Use Stream.eval(req).flatMap(client.stream).flatMap(f)

  28. abstract def streaming[A](req: Request[F])(f: (Response[F]) ⇒ Stream[F, A]): Stream[F, A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0-M4) Use client.stream(req).flatMap(f)

Concrete Value Members

  1. def translate[G[_]](fk: ~>[F, G])(gK: ~>[G, F])(implicit arg0: Async[G], F: MonadCancel[F, Throwable]): Client[G]

    Translates the effect type of this client from F to G