Client

Instance Constructors

new Client(open: Service[Request, DisposableResponse], shutdown: Task[Unit])

open
a service to asynchronously return a DisposableResponse from a Request. This is a low-level operation intended for client implementations and middleware.
shutdown
a Task to shut down this Shutdown this client, closing any open connections and freeing resources

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def expect[A](s: String)(implicit d: EntityDecoder[A]): Task[A]

Submits a GET request to the URI specified by the String and decodes the response on success.
Submits a GET request to the URI specified by the String and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.
def expect[A](uri: Uri)(implicit d: EntityDecoder[A]): Task[A]

Submits a GET request to the specified URI and decodes the response on success.
Submits a GET request to the specified URI and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.
def expect[A](req: Task[Request])(implicit d: EntityDecoder[A]): Task[A]
def expect[A](req: Request)(implicit d: EntityDecoder[A]): Task[A]

Submits a request and decodes the response on success.
Submits a request and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.
def fetch[A](req: Task[Request])(f: (Response) ⇒ Task[A]): Task[A]

Submits a request, and provides a callback to process the response.
Submits a request, and provides a callback to process the response.
req
A Task of the request to submit
f
A callback for the response to req. The underlying HTTP connection is disposed when the returned task completes. Attempts to read the response body afterward will result in an error.
returns
The result of applying f to the response to req
def fetch[A](req: Request)(f: (Response) ⇒ Task[A]): Task[A]

Submits a request, and provides a callback to process the response.
Submits a request, and provides a callback to process the response.
req
The request to submit
f
A callback for the response to req. The underlying HTTP connection is disposed when the returned task completes. Attempts to read the response body afterward will result in an error.
returns
The result of applying f to the response to req
def fetchAs[A](req: Task[Request])(implicit d: EntityDecoder[A]): Task[A]

Submits a request and decodes the response, regardless of the status code.
Submits a request and decodes the response, regardless of the status code. The underlying HTTP connection is closed at the completion of the decoding.
def fetchAs[A](req: Request)(implicit d: EntityDecoder[A]): Task[A]

Submits a request and decodes the response, regardless of the status code.
Submits a request and decodes the response, regardless of the status code. The underlying HTTP connection is closed at the completion of the decoding.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get[A](s: String)(f: (Response) ⇒ Task[A]): Task[A]

Submits a request and decodes the response on success.
Submits a request and decodes the response on success. On failure, the status code is returned. The underlying HTTP connection is closed at the completion of the decoding.
def get[A](uri: Uri)(f: (Response) ⇒ Task[A]): Task[A]

Submits a GET request, and provides a callback to process the response.
Submits a GET request, and provides a callback to process the response.
uri
The URI to GET
f
A callback for the response to a GET on uri. The underlying HTTP connection is disposed when the returned task completes. Attempts to read the response body afterward will result in an error.
returns
The result of applying f to the response to req
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val open: Service[Request, DisposableResponse]

a service to asynchronously return a DisposableResponse from a Request.
a service to asynchronously return a DisposableResponse from a Request. This is a low-level operation intended for client implementations and middleware.
val shutdown: Task[Unit]

a Task to shut down this Shutdown this client, closing any open connections and freeing resources
def shutdownNow(): Unit

Shuts this client down, and blocks until complete.
def status(req: Task[Request]): Task[Status]

Submits a request and returns the response status
def status(req: Request): Task[Status]

Submits a request and returns the response status
def streaming[A](req: Task[Request])(f: (Response) ⇒ Stream[Task, A]): Stream[Task, A]
def streaming[A](req: Request)(f: (Response) ⇒ Stream[Task, A]): Stream[Task, A]
def successful(req: Task[Request]): Task[Boolean]

Submits a request and returns true if and only if the response status is successful
def successful(req: Request): Task[Boolean]

Submits a request and returns true if and only if the response status is successful
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toHttpService: HttpService

Returns this client as an HttpService.
Returns this client as an HttpService. It is the responsibility of callers of this service to run the response body to dispose of the underlying HTTP connection.
This is intended for use in proxy servers. fetch, fetchAs, toService, and streaming are safer alternatives, as their signatures guarantee disposal of the HTTP connection.
def toService[A](f: (Response) ⇒ Task[A]): Service[Request, A]

Returns this client as a Service.
Returns this client as a Service. All connections created by this service are disposed on completion of callback task f.
This method effectively reverses the arguments to fetch, and is preferred when an HTTP client is composed into a larger Kleisli function, or when a common response callback is used by many call sites.
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( ... )

Deprecated Value Members

def getAs[A](s: String)(implicit d: EntityDecoder[A]): Task[A]

Annotations
@deprecated
Deprecated
(Since version 0.14) Use expect
def getAs[A](uri: Uri)(implicit d: EntityDecoder[A]): Task[A]

Submits a GET request and decodes the response.
Submits a GET request and decodes the response. The underlying HTTP connection is closed at the completion of the decoding.

Annotations
@deprecated
Deprecated
(Since version 0.14) Use expect
def prepAs[T](req: Task[Request])(implicit d: EntityDecoder[T]): Task[T]

Annotations
@deprecated
Deprecated
(Since version 0.14) Use expect
def prepAs[A](req: Request)(implicit d: EntityDecoder[A]): Task[A]

Annotations
@deprecated
Deprecated
(Since version 0.14) Use expect

Related Docs: object Client | package client

final case class Client(open: Service[Request, DisposableResponse], shutdown: Task[Unit]) extends Product with Serializable

Instance Constructors

new Client(open: Service[Request, DisposableResponse], shutdown: Task[Unit])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def expect[A](s: String)(implicit d: EntityDecoder[A]): Task[A]

def expect[A](uri: Uri)(implicit d: EntityDecoder[A]): Task[A]

def expect[A](req: Task[Request])(implicit d: EntityDecoder[A]): Task[A]

def expect[A](req: Request)(implicit d: EntityDecoder[A]): Task[A]

def fetch[A](req: Task[Request])(f: (Response) ⇒ Task[A]): Task[A]

def fetch[A](req: Request)(f: (Response) ⇒ Task[A]): Task[A]

def fetchAs[A](req: Task[Request])(implicit d: EntityDecoder[A]): Task[A]

def fetchAs[A](req: Request)(implicit d: EntityDecoder[A]): Task[A]

def finalize(): Unit

def get[A](s: String)(f: (Response) ⇒ Task[A]): Task[A]

def get[A](uri: Uri)(f: (Response) ⇒ Task[A]): Task[A]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val open: Service[Request, DisposableResponse]

val shutdown: Task[Unit]

def shutdownNow(): Unit

def status(req: Task[Request]): Task[Status]

def status(req: Request): Task[Status]

def streaming[A](req: Task[Request])(f: (Response) ⇒ Stream[Task, A]): Stream[Task, A]

def streaming[A](req: Request)(f: (Response) ⇒ Stream[Task, A]): Stream[Task, A]

def successful(req: Task[Request]): Task[Boolean]

def successful(req: Request): Task[Boolean]

final def synchronized[T0](arg0: ⇒ T0): T0

def toHttpService: HttpService

def toService[A](f: (Response) ⇒ Task[A]): Service[Request, A]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def getAs[A](s: String)(implicit d: EntityDecoder[A]): Task[A]

def getAs[A](uri: Uri)(implicit d: EntityDecoder[A]): Task[A]

def prepAs[T](req: Task[Request])(implicit d: EntityDecoder[T]): Task[T]

def prepAs[A](req: Request)(implicit d: EntityDecoder[A]): Task[A]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped