ArmeriaClientBuilder

org.http4s.armeria.client.ArmeriaClientBuilder
See theArmeriaClientBuilder companion object
sealed class ArmeriaClientBuilder[F[_]]

Attributes

Companion:
object
Source:
ArmeriaClientBuilder.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def build(): Client[F]

Returns a newly-created http4s org.http4s.client.Client based on Armeria com.linecorp.armeria.client.WebClient.

Returns a newly-created http4s org.http4s.client.Client based on Armeria com.linecorp.armeria.client.WebClient.

Attributes

Source:
ArmeriaClientBuilder.scala
override def resource: Resource[F, Client[F]]

Returns the backend as a resource. Resource acquire waits until the backend is ready to process requests.

Returns the backend as a resource. Resource acquire waits until the backend is ready to process requests.

Attributes

Definition Classes
Source:
ArmeriaClientBuilder.scala

Configures the Armeria client using the specified com.linecorp.armeria.client.WebClientBuilder.

Configures the Armeria client using the specified com.linecorp.armeria.client.WebClientBuilder.

Attributes

Source:
ArmeriaClientBuilder.scala

Sets the com.linecorp.armeria.client.ClientFactory used for creating a client. The default is com.linecorp.armeria.client.ClientFactory.ofDefault().

Sets the com.linecorp.armeria.client.ClientFactory used for creating a client. The default is com.linecorp.armeria.client.ClientFactory.ofDefault().

Attributes

Source:
ArmeriaClientBuilder.scala

Adds the specified decorator.

Adds the specified decorator.

Attributes

decorator

the DecoratingFunction that transforms an com.linecorp.armeria.client.HttpClient to another.

Source:
ArmeriaClientBuilder.scala

Adds the specified decorator.

Adds the specified decorator.

Attributes

decorator

the java.util.function.Function that transforms an com.linecorp.armeria.client.HttpClient to another.

Source:
ArmeriaClientBuilder.scala
def withMaxResponseLength(maxResponseLength: Long): ArmeriaClientBuilder[F]

Sets the maximum allowed length of a server response in bytes.

Sets the maximum allowed length of a server response in bytes.

Attributes

maxResponseLength

the maximum length in bytes. 0 disables the limit.

Source:
ArmeriaClientBuilder.scala

Sets the timeout of a response.

Sets the timeout of a response.

Attributes

responseTimeout

the timeout. scala.concurrent.duration.Duration.Zero disables the timeout.

Source:
ArmeriaClientBuilder.scala

Sets the timeout of a socket write attempt.

Sets the timeout of a socket write attempt.

Attributes

writeTimeout

the timeout. scala.concurrent.duration.Duration.Zero disables the timeout.

Source:
ArmeriaClientBuilder.scala

Inherited methods

def stream: Stream[F, A]

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.

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.

Attributes

Inherited from:
BackendBuilder (hidden)
Source:
BackendBuilder.scala

Deprecated and Inherited methods

def allocated: F[(A, F[Unit])]

Returns an effect that allocates a backend and an F[Unit] to release it. The returned F waits until the backend is ready to process requests. The second element of the tuple shuts down the backend when run.

Returns an effect that allocates a backend and an F[Unit] to release it. The returned F waits 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.

Attributes

Deprecated
true
Inherited from:
BackendBuilder (hidden)
Source:
BackendBuilder.scala