com.linecorp.armeria.client

Class AllInOneClientFactory

java.lang.Object

com.linecorp.armeria.client.AbstractClientFactory

com.linecorp.armeria.client.AllInOneClientFactory

All Implemented Interfaces:

ClientFactory, java.lang.AutoCloseable

public class AllInOneClientFactory
extends AbstractClientFactory

A ClientFactory which combines all known official ClientFactory implementations. It currently combines the following ClientFactorys:

• HttpClientFactory
• THttpClientFactory

Field Summary

Fields inherited from interface com.linecorp.armeria.client.ClientFactory

DEFAULT

Constructor Summary

Constructors

Constructor and Description
AllInOneClientFactory() Creates a new instance with the default SessionOptions.
AllInOneClientFactory(boolean useDaemonThreads) Creates a new instance with the default SessionOptions.
AllInOneClientFactory(SessionOptions options) Creates a new instance with the specified SessionOptions.
AllInOneClientFactory(SessionOptions options, boolean useDaemonThreads) Creates a new instance with the specified SessionOptions.

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.
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.net.URI uri, java.lang.Class<T> clientType, ClientOptions 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.

Methods inherited from class com.linecorp.armeria.client.AbstractClientFactory

newClient, newClient, newClient, newEndpoint, validateScheme

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.client.ClientFactory

closeDefault

Constructor Detail

AllInOneClientFactory

public AllInOneClientFactory()

Creates a new instance with the default SessionOptions.

AllInOneClientFactory

public AllInOneClientFactory(boolean useDaemonThreads)

Creates a new instance with the default SessionOptions.

Parameters:

useDaemonThreads - whether to create I/O event loop threads as daemon threads

AllInOneClientFactory

public AllInOneClientFactory(SessionOptions options)

Creates a new instance with the specified SessionOptions.

AllInOneClientFactory

public AllInOneClientFactory(SessionOptions options,
                             boolean useDaemonThreads)

Creates a new instance with the specified SessionOptions.

Parameters:

useDaemonThreads - whether to create I/O event loop threads as daemon threads

Method Detail

supportedSchemes

public java.util.Set<Scheme> supportedSchemes()

Description copied from interface: ClientFactory

Returns the Schemes supported by this ClientFactory.

options

public SessionOptions options()

Description copied from interface: ClientFactory

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

eventLoopGroup

public io.netty.channel.EventLoopGroup eventLoopGroup()

Description copied from interface: ClientFactory

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 ClientFactory.eventLoopSupplier() instead if what you need is an EventLoop rather than an EventLoopGroup.

eventLoopSupplier

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

Description copied from interface: ClientFactory

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

newClient

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

Description copied from interface: ClientFactory

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

public void close()

Description copied from interface: ClientFactory

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