io.atomix.protocols.backup.session

Class PrimaryBackupSessionClient

java.lang.Object

io.atomix.protocols.backup.session.PrimaryBackupSessionClient

All Implemented Interfaces:

SessionClient

public class PrimaryBackupSessionClient
extends Object
implements SessionClient

Primary-backup session client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrimaryBackupSessionClient.Builder Primary-backup partition proxy builder.

Constructor Summary

Constructors

Constructor and Description

PrimaryBackupSessionClient(String clientName, PartitionId partitionId, SessionId sessionId, PrimitiveType primitiveType, io.atomix.protocols.backup.protocol.PrimitiveDescriptor descriptor, ClusterMembershipService clusterMembershipService, io.atomix.protocols.backup.protocol.PrimaryBackupClientProtocol protocol, PrimaryElection primaryElection, io.atomix.utils.concurrent.ThreadContext threadContext)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimaryBackupSessionClient

public PrimaryBackupSessionClient(String clientName,
                                  PartitionId partitionId,
                                  SessionId sessionId,
                                  PrimitiveType primitiveType,
                                  io.atomix.protocols.backup.protocol.PrimitiveDescriptor descriptor,
                                  ClusterMembershipService clusterMembershipService,
                                  io.atomix.protocols.backup.protocol.PrimaryBackupClientProtocol protocol,
                                  PrimaryElection primaryElection,
                                  io.atomix.utils.concurrent.ThreadContext threadContext)

Method Detail

name

public String name()

Description copied from interface: SessionClient

Returns the primitive name.

Specified by:

name in interface SessionClient

Returns:

the primitive name

type

public PrimitiveType type()

Description copied from interface: SessionClient

Returns the client proxy type.

Specified by:

type in interface SessionClient

Returns:

The client proxy type.

context

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

Description copied from interface: SessionClient

Returns the partition thread context.

Specified by:

context in interface SessionClient

Returns:

the partition thread context

getState

public PrimitiveState getState()

Description copied from interface: SessionClient

Returns the session state.

Specified by:

getState in interface SessionClient

Returns:

The session state.

partitionId

public PartitionId partitionId()

Description copied from interface: SessionClient

Returns the partition identifier.

Specified by:

partitionId in interface SessionClient

Returns:

the partition identifier.

sessionId

public SessionId sessionId()

Description copied from interface: SessionClient

Returns the proxy session identifier.

Specified by:

sessionId in interface SessionClient

Returns:

The proxy session identifier

addStateChangeListener

public void addStateChangeListener(Consumer<PrimitiveState> listener)

Description copied from interface: SessionClient

Registers a session state change listener.

Specified by:

addStateChangeListener in interface SessionClient

Parameters:

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

removeStateChangeListener

public void removeStateChangeListener(Consumer<PrimitiveState> listener)

Description copied from interface: SessionClient

Removes a state change listener.

Specified by:

removeStateChangeListener in interface SessionClient

Parameters:

listener - the state change listener to remove

execute

public CompletableFuture<byte[]> execute(PrimitiveOperation operation)

Description copied from interface: SessionClient

Executes an operation to the cluster.

Specified by:

execute in interface SessionClient

Parameters:

operation - the operation to execute

Returns:

a future to be completed with the operation result

addEventListener

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

Description copied from interface: SessionClient

Adds an event listener.

Specified by:

addEventListener in interface SessionClient

Parameters:

eventType - the event type for which to add the listener

listener - the event listener to add

removeEventListener

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

Description copied from interface: SessionClient

Removes an event listener.

Specified by:

removeEventListener in interface SessionClient

Parameters:

eventType - the event type for which to remove the listener

listener - the event listener to remove

connect

public CompletableFuture<SessionClient> connect()

Description copied from interface: SessionClient

Connects the proxy.

Specified by:

connect in interface SessionClient

Returns:

a future to be completed once the proxy has been connected

close

public CompletableFuture<Void> close()

Description copied from interface: SessionClient

Closes the proxy.

Specified by:

close in interface SessionClient

Returns:

a future to be completed once the proxy has been closed