fl-foundation/com.quickplay.vstb7.http/HttpClient

HttpClient

interface HttpClient : Call.Factory

The Client that is responsible for constructing a Call based on a Request and return an appropriate Response

Types

Builder

interface Builder

A convenience builder for constructing HttpClient object.

Properties

callTimeoutMillis

abstract val callTimeoutMillis: Int

Default call timeout (in milliseconds). By default there is no timeout for complete calls, but there is for the connect, write, and read actions within a call.

connectTimeoutMillis

abstract val connectTimeoutMillis: Int

Default connect timeout (in milliseconds)

readTimeoutMillis

abstract val readTimeoutMillis: Int

Default read timeout (in milliseconds).

writeTimeoutMillis

abstract val writeTimeoutMillis: Int

Default write timeout (in milliseconds).

Functions

callWith

abstract fun <ReqBody : Any, ResBody : Any> callWith(requestSerializationType: Type, responseDeSerializationType: Type, build: Request.Builder<ReqBody>.() -> Unit): Call<ReqBody, ResBody>

abstract fun <ReqBody : Any, ResBody : Any> ~~callWith~~(requestSerializationClass: KClass<ReqBody>, responseDeSerializationClass: KClass<ResBody>, build: Request.Builder<ReqBody>.() -> Unit): Call<ReqBody, ResBody>

Constructs a call with the passed Request Builder instance.

abstract fun <ReqBody : Any, ResBody : Any> callWith(requestSerializationClass: KClass<ReqBody>, responseDeSerializationClass: KClass<ResBody>, request: Request<ReqBody>): Call<ReqBody, ResBody>

Constructs a call with the passed Request instance.

callWith

inline fun <ReqBody : Any, ResBody : Any> Call.Factory.callWith(noinline builder: Request.Builder<ReqBody>.() -> Unit): Call<ReqBody, ResBody>

Constructs a call with the passed Request Builder instance. The Request and Response Types are passed as reified Generic Parameters.

newBuilder

abstract fun newBuilder(): HttpClient.Builder

Builds a new HttpClient with custom configuration but same underlying Resources.