io.servicetalk.client.api.internal

Class DefaultPartitionedClientGroup<U,R,Client extends ListenableAsyncCloseable>

java.lang.Object

io.servicetalk.client.api.internal.DefaultPartitionedClientGroup<U,R,Client>

Type Parameters:

U - the type of address before resolution (unresolved address)

R - the type of address after resolution (resolved address)

Client - the type of client to connect to the partitions

All Implemented Interfaces:

ClientGroup<PartitionAttributes,Client>, AsyncCloseable, ListenableAsyncCloseable

public final class DefaultPartitionedClientGroup<U,R,Client extends ListenableAsyncCloseable>
extends java.lang.Object
implements ClientGroup<PartitionAttributes,Client>

An implementation of ClientGroup that can be used for partitioned client use-cases where PartitionAttributes are discovered through PartitionedServiceDiscovererEvents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultPartitionedClientGroup.PartitionedClientFactory<U,R,Client> Factory for building partitioned clients.

Constructor Summary

Constructors

Constructor and Description

DefaultPartitionedClientGroup(java.util.function.Function<PartitionAttributes,Client> closedPartitionClient, java.util.function.Function<PartitionAttributes,Client> unknownPartitionClient, DefaultPartitionedClientGroup.PartitionedClientFactory<U,R,Client> clientFactory, PartitionMapFactory partitionMapFactory, Publisher<? extends PartitionedServiceDiscovererEvent<R>> psdEvents, int psdMaxQueueSize) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync() Used to close/shutdown a resource.
Completable	closeAsyncGracefully() Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
Client	get(PartitionAttributes partitionAttributes) Return the Client identified by the provided key or create a new one when none exists.
Completable	onClose() Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.client.api.ClientGroup

from

Constructor Detail

DefaultPartitionedClientGroup

public DefaultPartitionedClientGroup(java.util.function.Function<PartitionAttributes,Client> closedPartitionClient,
                                     java.util.function.Function<PartitionAttributes,Client> unknownPartitionClient,
                                     DefaultPartitionedClientGroup.PartitionedClientFactory<U,R,Client> clientFactory,
                                     PartitionMapFactory partitionMapFactory,
                                     Publisher<? extends PartitionedServiceDiscovererEvent<R>> psdEvents,
                                     int psdMaxQueueSize)

Creates a new instance.

Parameters:

closedPartitionClient - factory for clients that handle requests for a closed partition

unknownPartitionClient - factory for clients that handles requests for an unknown partition

clientFactory - used to create clients for newly discovered partitions

partitionMapFactory - factory to provide a PartitionMap implementation appropriate for the use-case

psdEvents - the stream of PartitionedServiceDiscovererEvents

psdMaxQueueSize - max number of new partitions to queue up

Method Detail

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A CompletableSource that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

get

public Client get(PartitionAttributes partitionAttributes)

Description copied from interface: ClientGroup

Return the Client identified by the provided key or create a new one when none exists.

Specified by:

get in interface ClientGroup<PartitionAttributes,Client extends ListenableAsyncCloseable>

Parameters:

partitionAttributes - the key identifying the client to return or create, this key may contain attributes about the requested client in order to create new instances

Returns:

a client assigned to the provided key, either by looking up an existing or creating a new instance if non-existent