io.atomix.primitive.session

Interface SessionClient

All Known Subinterfaces:

RaftSessionClient

All Known Implementing Classes:

PrimaryBackupSessionClient

public interface SessionClient

Partition proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionClient.Builder Partition proxy builder.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(EventType eventType, Consumer<PrimitiveEvent> listener) Adds an event listener.
void	addStateChangeListener(Consumer<PrimitiveState> listener) Registers a session state change listener.
CompletableFuture<Void>	close() Closes the proxy.
CompletableFuture<SessionClient>	connect() Connects the proxy.
io.atomix.utils.concurrent.ThreadContext	context() Returns the partition thread context.
CompletableFuture<byte[]>	execute(PrimitiveOperation operation) Executes an operation to the cluster.
PrimitiveState	getState() Returns the session state.
String	name() Returns the primitive name.
PartitionId	partitionId() Returns the partition identifier.
void	removeEventListener(EventType eventType, Consumer<PrimitiveEvent> listener) Removes an event listener.
void	removeStateChangeListener(Consumer<PrimitiveState> listener) Removes a state change listener.
SessionId	sessionId() Returns the proxy session identifier.
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.

getState

PrimitiveState getState()

Returns the session state.

Returns:

The session state.

sessionId

SessionId sessionId()

Returns the proxy session identifier.

Returns:

The proxy session identifier

partitionId

PartitionId partitionId()

Returns the partition identifier.

Returns:

the partition identifier.

context

io.atomix.utils.concurrent.ThreadContext context()

Returns the partition thread context.

Returns:

the partition thread context

execute

CompletableFuture<byte[]> execute(PrimitiveOperation operation)

Executes an operation to the cluster.

Parameters:

operation - the operation to execute

Returns:

a future to be completed with the operation result

Throws:

NullPointerException - if operation is null

addEventListener

void addEventListener(EventType eventType,
                      Consumer<PrimitiveEvent> listener)

Adds an event listener.

Parameters:

eventType - the event type for which to add the listener

listener - the event listener to add

removeEventListener

void removeEventListener(EventType eventType,
                         Consumer<PrimitiveEvent> listener)

Removes an event listener.

Parameters:

eventType - the event type for which to remove the listener

listener - the event listener to remove

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<SessionClient> connect()

Connects the proxy.

Returns:

a future to be completed once the proxy has been connected

close

CompletableFuture<Void> close()

Closes the proxy.

Returns:

a future to be completed once the proxy has been closed