com.linecorp.armeria.client

Interface ClientFactory

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AbstractClientFactory, AllInOneClientFactory, DecoratingClientFactory, HttpClientFactory, NonDecoratingClientFactory, THttpClientFactory

public interface ClientFactory
extends java.lang.AutoCloseable

Creates and manages clients.

Life cycle of the default ClientFactory

Clients or ClientBuilder uses DEFAULT, the default ClientFactory, unless you specified a ClientFactory explicitly. Calling close() on the default ClientFactory will neither terminate its I/O threads nor release other related resources unlike other ClientFactory to protect itself from accidental premature termination.

Instead, when the current ClassLoader is the system class loader, a shutdown hook is registered so that they are released when the JVM exits.

If you are in an environment managed by a container or you desire the early termination of the default ClientFactory, use closeDefault().

Field Summary

Fields

Modifier and Type	Field and Description
static ClientFactory	DEFAULT The default ClientFactory implementation.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all clients managed by this factory and shuts down the EventLoopGroup created implicitly by this factory.
static void	closeDefault() Closes the default ClientFactory.
io.netty.channel.EventLoopGroup	eventLoopGroup() Returns the EventLoopGroup being used by this ClientFactory.
java.util.function.Supplier<io.netty.channel.EventLoop>	eventLoopSupplier() Returns a Supplier that provides one of the EventLoops being used by this ClientFactory.
<T> T	newClient(java.lang.String uri, java.lang.Class<T> clientType, ClientOptions options) Creates a new client that connects to the specified uri.
<T> T	newClient(java.lang.String uri, java.lang.Class<T> clientType, ClientOptionValue<?>... options) Creates a new client that connects to the specified uri.
<T> T	newClient(java.net.URI uri, java.lang.Class<T> clientType, ClientOptions options) Creates a new client that connects to the specified URI using the default ClientFactory.
<T> T	newClient(java.net.URI uri, java.lang.Class<T> clientType, ClientOptionValue<?>... options) Creates a new client that connects to the specified URI using the default ClientFactory.
SessionOptions	options() Returns the session-layer options of the connections created by this ClientFactory.
java.util.Set<Scheme>	supportedSchemes() Returns the Schemes supported by this ClientFactory.

Field Detail

DEFAULT

static final ClientFactory DEFAULT

The default ClientFactory implementation.

Method Detail

closeDefault

static void closeDefault()

Closes the default ClientFactory.

supportedSchemes

java.util.Set<Scheme> supportedSchemes()

Returns the Schemes supported by this ClientFactory.

options

SessionOptions options()

Returns the session-layer options of the connections created by this ClientFactory.

eventLoopGroup

io.netty.channel.EventLoopGroup eventLoopGroup()

Returns the EventLoopGroup being used by this ClientFactory. Can be used to, e.g., schedule a periodic task without creating a separate event loop. Use eventLoopSupplier() instead if what you need is an EventLoop rather than an EventLoopGroup.

eventLoopSupplier

java.util.function.Supplier<io.netty.channel.EventLoop> eventLoopSupplier()

Returns a Supplier that provides one of the EventLoops being used by this ClientFactory.

newClient

<T> T newClient(java.lang.String uri,
                java.lang.Class<T> clientType,
                ClientOptionValue<?>... options)

Creates a new client that connects to the specified uri.

Parameters:

uri - the URI of the server endpoint

clientType - the type of the new client

options - the ClientOptionValues

newClient

<T> T newClient(java.lang.String uri,
                java.lang.Class<T> clientType,
                ClientOptions options)

Creates a new client that connects to the specified uri.

Parameters:

uri - the URI of the server endpoint

clientType - the type of the new client

options - the ClientOptions

newClient

<T> T newClient(java.net.URI uri,
                java.lang.Class<T> clientType,
                ClientOptionValue<?>... options)

Creates a new client that connects to the specified URI using the default ClientFactory.

Parameters:

uri - the URI of the server endpoint

clientType - the type of the new client

options - the ClientOptionValues

newClient

<T> T newClient(java.net.URI uri,
                java.lang.Class<T> clientType,
                ClientOptions options)

Creates a new client that connects to the specified URI using the default ClientFactory.

Parameters:

uri - the URI of the server endpoint

clientType - the type of the new client

options - the ClientOptions

close

void close()

Closes all clients managed by this factory and shuts down the EventLoopGroup created implicitly by this factory.

Specified by:

close in interface java.lang.AutoCloseable