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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val F: ConcurrentEffect[F]
    Attributes
    protected
    Definition Classes
    OkHttpBuilder → BackendBuilder
  5. 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
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val blocker: Blocker
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. 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.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val okHttpClient: OkHttpClient
  20. 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
  21. 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
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def withBlocker(blocker: Blocker): OkHttpBuilder[F]
  28. 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

Inherited from BackendBuilder[F, Client[F]]

Inherited from AnyRef

Inherited from Any

Ungrouped