Package io.servicetalk.client.api.internal.partition

Class PowerSetPartitionMap<T extends AsyncCloseable>

java.lang.Object

io.servicetalk.client.api.internal.partition.PowerSetPartitionMap<T>

Type Parameters:

T - The partition type.

All Implemented Interfaces:

PartitionMap<T>, AsyncCloseable, ListenableAsyncCloseable

@Deprecated
public final class PowerSetPartitionMap<T extends AsyncCloseable>
extends Object
implements PartitionMap<T>

Deprecated.

We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.

A PartitionMap that creates the full power set using the individual attributes in PartitionAttributeses to create partitions for each add(PartitionAttributes).

Constructor Summary

Constructors

Constructor	Description
PowerSetPartitionMap(Function<PartitionAttributes,T> valueFactory, IntFunction<PartitionAttributesBuilder> partitionAttributesBuilderFunc)	Deprecated. Create a new instance.

Method Summary

Modifier and Type	Method	Description
List<T>	add(PartitionAttributes partition)	Deprecated. Add a new PartitionAttributes that is absolutely specified.
Completable	closeAsync()	Deprecated. Used to close/shutdown a resource.
Completable	closeAsyncGracefully()	Deprecated. Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
T	get(PartitionAttributes wildCardAttributes)	Deprecated. Get the partition value corresponding to the PartitionAttributes parameter.
Completable	onClose()	Deprecated. Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Completable	onClosing()	Deprecated. Returns a Completable that is notified when closing begins.
List<T>	remove(PartitionAttributes partition)	Deprecated. Remove a PartitionAttributes that was previously added via PartitionMap.add(PartitionAttributes).

Methods inherited from class java.lang.Object

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

Constructor Details

PowerSetPartitionMap

public PowerSetPartitionMap(Function<PartitionAttributes,T> valueFactory,
 IntFunction<PartitionAttributesBuilder> partitionAttributesBuilderFunc)

Deprecated.

Create a new instance.

Parameters:

valueFactory - Generates values for new partitions.

partitionAttributesBuilderFunc - Generates new PartitionAttributes objects, this factory must be consistent with the factory used to build the PartitionAttributes objects for add(PartitionAttributes) and remove(PartitionAttributes) to ensure Object.hashCode() and Object.equals(Object) are consistent.

Method Details

get

public T get(@Nullable
 PartitionAttributes wildCardAttributes)

Deprecated.

Description copied from interface: PartitionMap

Get the partition value corresponding to the PartitionAttributes parameter.

This may be called from any thread.

Specified by:

get in interface PartitionMap<T extends AsyncCloseable>

Parameters:

wildCardAttributes - A PartitionAttributes which identifies the partition. Note that this may not be fully specified, and this is where the "wild card" terminology comes from.

Returns:

the partition value corresponding to the PartitionAttributes parameter.

add

public List<T> add(PartitionAttributes partition)

Deprecated.

Description copied from interface: PartitionMap

Add a new PartitionAttributes that is absolutely specified. This may create new partitions.

The terminology "absolutely"/"fully" here is meant to clarify that partition contains all the attributes to uniquely identify a single host. This is typically called when notification is received from ServiceDiscoverer and that address is translated to the corresponding PartitionAttributes.

This method is not guaranteed to provide any thread safety or visibility with respect to calls to this method or PartitionMap.remove(PartitionAttributes). If these methods are called from multiple threads you may need to provide external synchronization.

Specified by:

add in interface PartitionMap<T extends AsyncCloseable>

Parameters:

partition - A fully specified PartitionAttributes.

Returns:

The partitions that partition belongs to. These may (or may not) be new partitions.

remove

public List<T> remove(PartitionAttributes partition)

Deprecated.

Description copied from interface: PartitionMap

Remove a PartitionAttributes that was previously added via PartitionMap.add(PartitionAttributes).

New partitions typically are not created as a result of this method call.

This method is not guaranteed to provide any thread safety or visibility with respect to calls to this method or PartitionMap.add(PartitionAttributes). If these methods are called from multiple threads you may need to provide external synchronization.

Specified by:

remove in interface PartitionMap<T extends AsyncCloseable>

Parameters:

partition - A fully specified PartitionAttributes.

Returns:

The partitions that partition belongs to.

onClose

public Completable onClose()

Deprecated.

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.

onClosing

public Completable onClosing()

Deprecated.

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified when closing begins.

Closing begin might be when a close operation is initiated locally (e.g. subscribing to AsyncCloseable.closeAsync()) or it could also be a transport event received from a remote peer (e.g. read a connection: close header).

For backwards compatibility this method maybe functionally equivalent to ListenableAsyncCloseable.onClose(). Therefore, provides a best-effort leading edge notification of closing, but may fall back to notification on trailing edge.

The goal of this method is often to notify asap when closing so this method may not be offloaded and care must be taken to avoid blocking if subscribing to the return Completable.

Specified by:

onClosing in interface ListenableAsyncCloseable

Returns:

a Completable that is notified when closing begins.

closeAsync

public Completable closeAsync()

Deprecated.

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Deprecated.

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.