sealed abstract class OkHttpBuilder[F[_]] extends BackendBuilder[F, Client[F]]
A builder for org.http4s.client.Client with an OkHttp backend.
- Source
- OkHttpBuilder.scala
- Alphabetic
- By Inheritance
- OkHttpBuilder
- BackendBuilder
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
implicit
val
F: ConcurrentEffect[F]
- Attributes
- protected
- Definition Classes
- OkHttpBuilder → BackendBuilder
-
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 returnedFwaits 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val blockingExecutionContext: ExecutionContext
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val okHttpClient: OkHttpClient
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withBlockingExecutionContext(blockingExecutionContext: ExecutionContext): OkHttpBuilder[F]
- def withOkHttpClient(okHttpClient: OkHttpClient): OkHttpBuilder[F]
-
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]]
Value Members
-
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 returnedFwaits 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
-
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
Inherited from AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Inherited from Any
Inherited by implicit conversion any2stringadd from OkHttpBuilder[F] to any2stringadd[OkHttpBuilder[F]]
Value Members
-
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
Inherited by implicit conversion StringFormat from OkHttpBuilder[F] to StringFormat[OkHttpBuilder[F]]
Value Members
-
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()
Inherited by implicit conversion Ensuring from OkHttpBuilder[F] to Ensuring[OkHttpBuilder[F]]
Value Members
-
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
-
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
-
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
-
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
Inherited by implicit conversion ArrowAssoc from OkHttpBuilder[F] to ArrowAssoc[OkHttpBuilder[F]]
Value Members
-
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()
-
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
Ungrouped
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
implicit
val
F: ConcurrentEffect[F]
- Attributes
- protected
- Definition Classes
- OkHttpBuilder → BackendBuilder
-
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 returnedFwaits 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val blockingExecutionContext: ExecutionContext
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val okHttpClient: OkHttpClient
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withBlockingExecutionContext(blockingExecutionContext: ExecutionContext): OkHttpBuilder[F]
- def withOkHttpClient(okHttpClient: OkHttpClient): OkHttpBuilder[F]
-
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