ember-client/org.http4s.ember.client/EmberClient

EmberClient

final class EmberClient[F[_]] extends DefaultClient[F]
class DefaultClient[F]
trait Client[F]
class Object
trait Matchable
class Any

Value members

Concrete methods

def run(req: Request[F]): Resource[F, Response[F]]
def state: F[(Int, Map[RequestKey, Int])]

The reason for this extra class. This allows you to see the present state of the underlying Pool, without having access to the pool itself.

The reason for this extra class. This allows you to see the present state of the underlying Pool, without having access to the pool itself.

The first element represents total connections in the pool, the second is a mapping between the number of connections in the pool for each requestKey.

Inherited methods

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. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.

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.

Inherited from:
DefaultClient
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. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.

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.

Inherited from:
DefaultClient
def expect[A](req: F[Request[F]])(implicit d: EntityDecoder[F, A]): F[A]
Inherited from:
DefaultClient
def expect[A](req: Request[F])(implicit d: EntityDecoder[F, A]): F[A]

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.

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.

Inherited from:
DefaultClient
def expectOption[A](req: Request[F])(implicit d: EntityDecoder[F, A]): F[Option[A]]
Inherited from:
DefaultClient
def expectOptionOr[A](req: Request[F])(onError: Response[F] => F[Throwable])(implicit d: EntityDecoder[F, A]): F[Option[A]]
Inherited from:
DefaultClient
final def expectOptionOrT[A](req: Request[F])(onError: Response[F] => F[Throwable])(implicit d: EntityDecoder[F, A]): OptionT[F, A]

As expectOptionOr, but defined in terms of cats.data.OptionT.

As expectOptionOr, but defined in terms of cats.data.OptionT.

Inherited from:
Client
final def expectOptionT[A](req: Request[F])(implicit d: EntityDecoder[F, A]): OptionT[F, A]

As expectOption, but defined in terms of cats.data.OptionT.

As expectOption, but defined in terms of cats.data.OptionT.

Inherited from:
Client
def expectOr[A](s: String)(onError: Response[F] => F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
Inherited from:
DefaultClient
def expectOr[A](uri: Uri)(onError: Response[F] => F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
Inherited from:
DefaultClient
def expectOr[A](req: F[Request[F]])(onError: Response[F] => F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
Inherited from:
DefaultClient
def expectOr[A](req: Request[F])(onError: Response[F] => F[Throwable])(implicit d: EntityDecoder[F, A]): F[A]
Inherited from:
DefaultClient
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.

Value parameters:
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.

req

An effect of the request to submit

Returns:

The result of applying f to the response to req

Inherited from:
DefaultClient
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.

Value parameters:
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.

req

The request to submit

Returns:

The result of applying f to the response to req

Inherited from:
DefaultClient
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. The underlying HTTP connection is closed at the completion of the decoding.

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

Inherited from:
DefaultClient
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. The underlying HTTP connection is closed at the completion of the decoding.

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

Inherited from:
DefaultClient
def get[A](s: String)(f: Response[F] => F[A]): F[A]

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.

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.

Inherited from:
DefaultClient
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.

Value parameters:
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.

uri

The URI to GET

Returns:

The result of applying f to the response to req

Inherited from:
DefaultClient
def status(req: F[Request[F]]): F[Status]

Submits a request and returns the response status

Submits a request and returns the response status

Inherited from:
DefaultClient
def status(req: Request[F]): F[Status]

Submits a request and returns the response status

Submits a request and returns the response status

Inherited from:
DefaultClient
override def statusFromString(s: String): F[Status]

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

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

Definition Classes
Inherited from:
DefaultClient
override def statusFromUri(uri: Uri): F[Status]

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

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

Definition Classes
Inherited from:
DefaultClient
def stream(req: Request[F]): Stream[F, Response[F]]
Inherited from:
DefaultClient
def streaming[A](req: F[Request[F]])(f: Response[F] => Stream[F, A]): Stream[F, A]
Inherited from:
DefaultClient
def streaming[A](req: Request[F])(f: Response[F] => Stream[F, A]): Stream[F, A]
Inherited from:
DefaultClient
def successful(req: F[Request[F]]): F[Boolean]

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

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

Inherited from:
DefaultClient
def successful(req: Request[F]): F[Boolean]

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

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

Inherited from:
DefaultClient
def toHttpApp: HttpApp[F]

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.

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 signatures guarantee disposal of the HTTP connection.

Inherited from:
DefaultClient
def toKleisli[A](f: Response[F] => F[A]): Kleisli[F, Request[F], A]

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

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.

Inherited from:
DefaultClient
def translate[G[_] : MonadCancelThrow](fk: FunctionK[F, G])(gK: FunctionK[G, F])(implicit evidence$2: MonadCancelThrow[G], F: MonadCancelThrow[F]): Client[G]

Translates the effect type of this client from F to G

Translates the effect type of this client from F to G

Inherited from:
Client