io.atomix.protocols.backup.protocol

Interface PrimaryBackupServerProtocol

public interface PrimaryBackupServerProtocol

Primary-backup server protocol.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<BackupResponse>	backup(io.atomix.cluster.NodeId nodeId, BackupRequest request) Sends a backup request to the given node.
void	event(io.atomix.cluster.NodeId nodeId, io.atomix.primitive.session.SessionId session, io.atomix.primitive.event.PrimitiveEvent event) Sends a primitive event to the given node.
void	registerBackupHandler(Function<BackupRequest,CompletableFuture<BackupResponse>> handler) Registers a backup request callback.
void	registerCloseHandler(Function<CloseRequest,CompletableFuture<CloseResponse>> handler) Registers a close request callback.
void	registerExecuteHandler(Function<ExecuteRequest,CompletableFuture<ExecuteResponse>> handler) Registers a execute request callback.
void	registerMetadataHandler(Function<MetadataRequest,CompletableFuture<MetadataResponse>> handler) Registers a metadata request callback.
void	registerRestoreHandler(Function<RestoreRequest,CompletableFuture<RestoreResponse>> handler) Registers a restore request callback.
CompletableFuture<RestoreResponse>	restore(io.atomix.cluster.NodeId nodeId, RestoreRequest request) Sends a restore request to the given node.
void	unregisterBackupHandler() Unregisters the backup request handler.
void	unregisterCloseHandler() Unregisters the close request handler.
void	unregisterExecuteHandler() Unregisters the execute request handler.
void	unregisterMetadataHandler() Unregisters the metadata request handler.
void	unregisterRestoreHandler() Unregisters the restore request handler.

Method Detail

backup

CompletableFuture<BackupResponse> backup(io.atomix.cluster.NodeId nodeId,
                                         BackupRequest request)

Sends a backup request to the given node.

Parameters:

nodeId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

restore

CompletableFuture<RestoreResponse> restore(io.atomix.cluster.NodeId nodeId,
                                           RestoreRequest request)

Sends a restore request to the given node.

Parameters:

nodeId - the node to which to send the request

request - the request to send

Returns:

a future to be completed with the response

event

void event(io.atomix.cluster.NodeId nodeId,
           io.atomix.primitive.session.SessionId session,
           io.atomix.primitive.event.PrimitiveEvent event)

Sends a primitive event to the given node.

Parameters:

nodeId - the node to which to publish the event

session - the session to which to publish the event

event - the primitive event to publish

registerExecuteHandler

void registerExecuteHandler(Function<ExecuteRequest,CompletableFuture<ExecuteResponse>> handler)

Registers a execute request callback.

Parameters:

handler - the execute request handler to register

unregisterExecuteHandler

void unregisterExecuteHandler()

Unregisters the execute request handler.

registerBackupHandler

void registerBackupHandler(Function<BackupRequest,CompletableFuture<BackupResponse>> handler)

Registers a backup request callback.

Parameters:

handler - the backup request handler to register

unregisterBackupHandler

void unregisterBackupHandler()

Unregisters the backup request handler.

registerRestoreHandler

void registerRestoreHandler(Function<RestoreRequest,CompletableFuture<RestoreResponse>> handler)

Registers a restore request callback.

Parameters:

handler - the restore request handler to register

unregisterRestoreHandler

void unregisterRestoreHandler()

Unregisters the restore request handler.

registerCloseHandler

void registerCloseHandler(Function<CloseRequest,CompletableFuture<CloseResponse>> handler)

Registers a close request callback.

Parameters:

handler - the close request handler to register

unregisterCloseHandler

void unregisterCloseHandler()

Unregisters the close request handler.

registerMetadataHandler

void registerMetadataHandler(Function<MetadataRequest,CompletableFuture<MetadataResponse>> handler)

Registers a metadata request callback.

Parameters:

handler - the metadata request handler to register

unregisterMetadataHandler

void unregisterMetadataHandler()

Unregisters the metadata request handler.