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
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to any2stringadd[OkHttpBuilder[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (OkHttpBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to ArrowAssoc[OkHttpBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. implicit val F: ConcurrentEffect[F]
    Attributes
    protected
    Definition Classes
    OkHttpBuilder → BackendBuilder
  7. 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
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val blockingExecutionContext: ExecutionContext
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. 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.

  12. def ensuring(cond: (OkHttpBuilder[F]) ⇒ Boolean, msg: ⇒ Any): OkHttpBuilder[F]
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to Ensuring[OkHttpBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (OkHttpBuilder[F]) ⇒ Boolean): OkHttpBuilder[F]
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to Ensuring[OkHttpBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): OkHttpBuilder[F]
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to Ensuring[OkHttpBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): OkHttpBuilder[F]
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to Ensuring[OkHttpBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to StringFormat[OkHttpBuilder[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val okHttpClient: OkHttpClient
  27. 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
  28. 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
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. def withBlockingExecutionContext(blockingExecutionContext: ExecutionContext): OkHttpBuilder[F]
  35. def withOkHttpClient(okHttpClient: OkHttpClient): OkHttpBuilder[F]
  36. def [B](y: B): (OkHttpBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from OkHttpBuilder[F] to ArrowAssoc[OkHttpBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from BackendBuilder[F, Client[F]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from OkHttpBuilder[F] to any2stringadd[OkHttpBuilder[F]]

Inherited by implicit conversion StringFormat from OkHttpBuilder[F] to StringFormat[OkHttpBuilder[F]]

Inherited by implicit conversion Ensuring from OkHttpBuilder[F] to Ensuring[OkHttpBuilder[F]]

Inherited by implicit conversion ArrowAssoc from OkHttpBuilder[F] to ArrowAssoc[OkHttpBuilder[F]]

Ungrouped