io.atomix.primitive.proxy

Interface ProxyClient<S>

public interface ProxyClient<S>

Primitive proxy.

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Void>	acceptAll(Consumer<S> operation) Submits an empty operation to all partitions.
default CompletableFuture<Void>	acceptBy(String key, Consumer<S> operation) Submits an empty operation to the owning partition for the given key.
default CompletableFuture<Void>	acceptOn(PartitionId partitionId, Consumer<S> operation) Submits an empty operation to the given partition.
void	addStateChangeListener(Consumer<PrimitiveState> listener) Registers a session state change listener.
default <R> CompletableFuture<Stream<R>>	applyAll(Function<S,R> operation) Submits an empty operation to all partitions.
default <R> CompletableFuture<R>	applyBy(Object key, Function<S,R> operation) Submits an empty operation to the owning partition for the given key.
default <R> CompletableFuture<R>	applyBy(String key, Function<S,R> operation) Submits an empty operation to the owning partition for the given key.
default <R> CompletableFuture<R>	applyOn(PartitionId partitionId, Function<S,R> operation) Submits an empty operation to the given partition.
CompletableFuture<Void>	close() Closes the proxy client.
CompletableFuture<ProxyClient<S>>	connect() Connects the proxy client.
default ProxySession<S>	getPartition(Object key) Returns the partition proxy for the given key.
ProxySession<S>	getPartition(PartitionId partitionId) Returns the proxy with the given identifier.
default ProxySession<S>	getPartition(String key) Returns the partition proxy for the given key.
PartitionId	getPartitionId(Object key) Returns the partition ID for the given key.
PartitionId	getPartitionId(String key) Returns the partition ID for the given key.
Collection<PartitionId>	getPartitionIds() Returns the collection of all partition IDs.
Collection<ProxySession<S>>	getPartitions() Returns the collection of all partition proxies.
PrimitiveState	getState() Returns the session state.
String	name() Returns the primitive name.
PrimitiveProtocol	protocol() Returns the client proxy protocol.
default void	register(Object client) Registers a client proxy.
void	removeStateChangeListener(Consumer<PrimitiveState> listener) Removes a state change listener.
PrimitiveType	type() Returns the client proxy type.

Method Detail

name

String name()

Returns the primitive name.

Returns:

the primitive name

type

PrimitiveType type()

Returns the client proxy type.

Returns:

The client proxy type.

protocol

PrimitiveProtocol protocol()

Returns the client proxy protocol.

Returns:

the client proxy protocol

getState

PrimitiveState getState()

Returns the session state.

Returns:

The session state.

getPartitions

Collection<ProxySession<S>> getPartitions()

Returns the collection of all partition proxies.

Returns:

the collection of all partition proxies

getPartitionIds

Collection<PartitionId> getPartitionIds()

Returns the collection of all partition IDs.

Returns:

the collection of all partition IDs

getPartition

ProxySession<S> getPartition(PartitionId partitionId)

Returns the proxy with the given identifier.

Parameters:

partitionId - the partition with the given identifier

Returns:

the partition proxy with the given identifier

getPartitionId

PartitionId getPartitionId(String key)

Returns the partition ID for the given key.

Parameters:

key - the key for which to return the partition ID

Returns:

the partition ID for the given key

getPartitionId

PartitionId getPartitionId(Object key)

Returns the partition ID for the given key.

Parameters:

key - the key for which to return the partition ID

Returns:

the partition ID for the given key

getPartition

default ProxySession<S> getPartition(String key)

Returns the partition proxy for the given key.

Parameters:

key - the key for which to return the partition proxy

Returns:

the partition proxy for the given key

getPartition

default ProxySession<S> getPartition(Object key)

Returns the partition proxy for the given key.

Parameters:

key - the key for which to return the partition proxy

Returns:

the partition proxy for the given key

register

default void register(Object client)

Registers a client proxy.

Parameters:

client - the client proxy to register

acceptAll

default CompletableFuture<Void> acceptAll(Consumer<S> operation)

Submits an empty operation to all partitions.

Parameters:

operation - the operation identifier

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

applyAll

default <R> CompletableFuture<Stream<R>> applyAll(Function<S,R> operation)

Submits an empty operation to all partitions.

Type Parameters:

R - the operation result type

Parameters:

operation - the operation identifier

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

acceptOn

default CompletableFuture<Void> acceptOn(PartitionId partitionId,
                                         Consumer<S> operation)

Submits an empty operation to the given partition.

Parameters:

partitionId - the partition in which to execute the operation

operation - the operation identifier

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

applyOn

default <R> CompletableFuture<R> applyOn(PartitionId partitionId,
                                         Function<S,R> operation)

Submits an empty operation to the given partition.

Type Parameters:

R - the operation result type

Parameters:

partitionId - the partition in which to execute the operation

operation - the operation identifier

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

acceptBy

default CompletableFuture<Void> acceptBy(String key,
                                         Consumer<S> operation)

Submits an empty operation to the owning partition for the given key.

Parameters:

key - the key for which to submit the operation

operation - the operation

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

applyBy

default <R> CompletableFuture<R> applyBy(String key,
                                         Function<S,R> operation)

Submits an empty operation to the owning partition for the given key.

Type Parameters:

R - the operation result type

Parameters:

key - the key for which to submit the operation

operation - the operation

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

applyBy

default <R> CompletableFuture<R> applyBy(Object key,
                                         Function<S,R> operation)

Submits an empty operation to the owning partition for the given key.

Type Parameters:

R - the operation result type

Parameters:

key - the key for which to submit the operation

operation - the operation

Returns:

A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.

Throws:

NullPointerException - if operation is null

addStateChangeListener

void addStateChangeListener(Consumer<PrimitiveState> listener)

Registers a session state change listener.

Parameters:

listener - The callback to call when the session state changes.

removeStateChangeListener

void removeStateChangeListener(Consumer<PrimitiveState> listener)

Removes a state change listener.

Parameters:

listener - the state change listener to remove

connect

CompletableFuture<ProxyClient<S>> connect()

Connects the proxy client.

Returns:

a future to be completed once the proxy client has been connected

close

CompletableFuture<Void> close()

Closes the proxy client.

Returns:

a future to be completed once the proxy client has been closed