unidocs
0.23.20
API
Generated with
unidocs/org.http4s/org.http4s.client

org.http4s.client

package org.http4s.client

Members list

Packages

package org.http4s.client.dsl
package org.http4s.client.middleware
package org.http4s.client.oauth1

Basic OAuth1 message signing support

Basic OAuth1 message signing support

This feature is not considered stable.

Attributes

package org.http4s.client.testkit
package org.http4s.client.websocket

Type members

Classlikes

trait Client[F[_]]

A Client submits Requests to a server and processes the Response.

A Client submits Requests to a server and processes the Response.

When a connection is "released" and the HTTP semantics of the request and response permit, the connection may be kept alive by the backend and used for a subsequent request. When HTTP semantics require it, or at the backend's discretion, a released connection may also be closed.

Attributes

Companion
object
Source
Client.scala
Supertypes
class Object
trait Matchable
class Any
object Client

Attributes

Companion
trait
Source
Client.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Client.type
class ConnectionFailure(val requestKey: RequestKey, val upstream: InetSocketAddress, val cause: Throwable) extends IOException

Indicates a failure to establish a client connection, preserving the request key that we tried to connect to.

Indicates a failure to establish a client connection, preserving the request key that we tried to connect to.

Attributes

Companion
object
Source
ConnectionFailure.scala
Supertypes
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ConnectionFailure

Attributes

Companion
class
Source
ConnectionFailure.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class JavaNetClientBuilder[F[_]]

Builder for a Client backed by on java.net.HttpUrlConnection.

Builder for a Client backed by on java.net.HttpUrlConnection.

The java.net client adds no dependencies beyond http4s-client. This client is generally not production grade, but convenient for exploration in a REPL.

All I/O operations in this client are blocking.

Attributes

Companion
object
Source
JavaNetClientBuilder.scala
Supertypes
class Object
trait Matchable
class Any
object JavaNetClientBuilder

Builder for a Client backed by on java.net.HttpUrlConnection.

Builder for a Client backed by on java.net.HttpUrlConnection.

Attributes

Companion
class
Source
JavaNetClientBuilder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class RequestKey(scheme: Scheme, authority: Authority)

Represents a key for requests that can conceivably share a Connection.

Represents a key for requests that can conceivably share a Connection.

Attributes

Companion
object
Source
RequestKey.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequestKey

Attributes

Companion
class
Source
RequestKey.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RequestKey.type
final case class UnexpectedStatus(status: Status, requestMethod: Method, requestUri: Uri) extends RuntimeException, NoStackTrace

Attributes

Source
Client.scala
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object defaults

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
defaults.type

Deprecated classlikes

trait Connection[F[_]]

Attributes

Deprecated
true
Source
Connection.scala
Supertypes
class Object
trait Matchable
class Any

Inherited types

type Middleware[F[_]] = Client[F] => Client[F]

Attributes

Inherited from:
ClientTypes
Source
package.scala

Deprecated and Inherited types

type ConnectionBuilder[F[_], A <: Connection[F]] = RequestKey => F[A]

Attributes

Deprecated
true
Inherited from:
ClientTypes
Source
package.scala
Generated with