sealed abstract class OkHttpBuilder[F[_]] extends AnyRef
A builder for org.http4s.client.Client with an OkHttp backend.
- Source
- OkHttpBuilder.scala
Ordering
- Alphabetic
- By Inheritance
Inherited
- OkHttpBuilder
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val blockingExecutionContext: ExecutionContext
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
create(implicit F: ConcurrentEffect[F], cs: ContextShift[F]): 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[java.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(implicit F: ConcurrentEffect[F], cs: ContextShift[F]): Resource[F, Client[F]]
Creates the org,http4s.client.Client as a resource.
Creates the org,http4s.client.Client as a resource.
The release on this resource 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
stream(implicit F: ConcurrentEffect[F], cs: ContextShift[F]): Stream[F, Client[F]]
Creates the org,http4s.client.Client as a singleton stream.
Creates the org,http4s.client.Client as a singleton stream.
The bracketed release on this stream 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.
-
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
- @native() @throws( ... )
- 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 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.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
- @native() @throws( ... )
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val blockingExecutionContext: ExecutionContext
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
create(implicit F: ConcurrentEffect[F], cs: ContextShift[F]): 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[java.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(implicit F: ConcurrentEffect[F], cs: ContextShift[F]): Resource[F, Client[F]]
Creates the org,http4s.client.Client as a resource.
Creates the org,http4s.client.Client as a resource.
The release on this resource 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
stream(implicit F: ConcurrentEffect[F], cs: ContextShift[F]): Stream[F, Client[F]]
Creates the org,http4s.client.Client as a singleton stream.
Creates the org,http4s.client.Client as a singleton stream.
The bracketed release on this stream 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.
-
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
- @native() @throws( ... )
- 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