Packages

sealed abstract class OkHttpBuilder[F[_]] extends BackendBuilder[F, Client[F]]

A builder for org.http4s.client.Client with an OkHttp backend.

Source
OkHttpBuilder.scala
Linear Supertypes
BackendBuilder[F, Client[F]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OkHttpBuilder
  2. BackendBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def allocated: F[(Client[F], F[Unit])]

    Returns an effect that allocates a backend and an F[Unit] to release it.

    Returns an effect that allocates a backend and an F[Unit] to release it. The returned F waits until the backend is ready to process requests. The second element of the tuple shuts down the backend when run.

    Unlike resource and stream, there is no automatic release of the backend. This function is intended for REPL sessions, tests, and other situations where composing a cats.effect.Resource or fs2.Stream is not tenable. resource or stream is recommended wherever possible.

    Definition Classes
    BackendBuilder
  2. val blocker: Blocker
  3. def create: Client[F]

    Creates the org.http4s.client.Client

    Creates the org.http4s.client.Client

    The shutdown method on this client is a no-op. It is assumed that the OkHttp client is passed to us as a Resource, or that the caller will shut it down, or that the caller is comfortable letting OkHttp's resources expire on their own.

  4. val okHttpClient: OkHttpClient
  5. def resource: Resource[F, Client[F]]

    Returns the backend as a resource.

    Returns the backend as a resource. Resource acquire waits until the backend is ready to process requests.

    Definition Classes
    OkHttpBuilder → BackendBuilder
  6. def stream: Stream[F, Client[F]]

    Returns the backend as a single-element stream.

    Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.

    Definition Classes
    BackendBuilder
  7. def withBlocker(blocker: Blocker): OkHttpBuilder[F]
  8. def withOkHttpClient(okHttpClient: OkHttpClient): OkHttpBuilder[F]

Deprecated Value Members

  1. def withBlockingExecutionContext(blockingExecutionContext: ExecutionContext): OkHttpBuilder[F]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0) Use withBlocker instead