OkHttpBuilder

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

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

Companion
object
trait BackendBuilder[F, Client[F]]
class Object
trait Matchable
class Any

Value members

Concrete methods

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.

def resource: Resource[F, Client[F]]
def withBlocker(blocker: Blocker): OkHttpBuilder[F]
def withOkHttpClient(okHttpClient: OkHttpClient): OkHttpBuilder[F]

Deprecated methods

@deprecated("Use withBlocker instead", "0.21.0")
def withBlockingExecutionContext(blockingExecutionContext: ExecutionContext): OkHttpBuilder[F]
Deprecated

Inherited methods

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

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.

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.

Inherited from
BackendBuilder
def stream: Stream[F, Client[F]]

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.

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.

Inherited from
BackendBuilder

Concrete fields

val blocker: Blocker
val okHttpClient: OkHttpClient