sila_java.library.server_base.command.observable

Class ObservableCommandManager<ParamType,ResultType>

java.lang.Object

sila_java.library.server_base.command.observable.ObservableCommandManager<ParamType,ResultType>

Type Parameters:

ParamType - The command parameter type

ResultType - The command result type

All Implemented Interfaces:

AutoCloseable

public class ObservableCommandManager<ParamType,ResultType>
extends Object
implements AutoCloseable

Observable command manager

Constructor Summary

Constructors

Constructor and Description
ObservableCommandManager(@NonNull ObservableCommandTaskRunner taskRunner, @NonNull RunnableCommandTask<ParamType,ResultType> task) Constructor
ObservableCommandManager(@NonNull ObservableCommandTaskRunner taskRunner, @NonNull RunnableCommandTask<ParamType,ResultType> task, Duration lifeTimeOfCommandExecution) Constructor

Method Summary

Modifier and Type	Method and Description
ObservableCommandWrapper<ParamType,ResultType>	addCommand(ParamType param, @NonNull StreamObserver<SiLAFramework.CommandConfirmation> observer) Add a command to the manager
void	close() Close all resources owned by the manager After this call the manager won't be usable anymore
ObservableCommandWrapper<ParamType,ResultType>	get(SiLAFramework.CommandExecutionUUID executionId) Retrieve a command from the manager
ObservableCommandWrapper<ParamType,ResultType>	get(@NonNull UUID executionId) Retrieve a command from the manager
void	remove(@NonNull UUID executionId) Remove a command from the manager

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservableCommandManager

public ObservableCommandManager(@NonNull
                                @NonNull ObservableCommandTaskRunner taskRunner,
                                @NonNull
                                @NonNull RunnableCommandTask<ParamType,ResultType> task)

Constructor

Parameters:

taskRunner - The runner

task - The task that each commands will run Commands will never expire unless removed manually

ObservableCommandManager

public ObservableCommandManager(@NonNull
                                @NonNull ObservableCommandTaskRunner taskRunner,
                                @NonNull
                                @NonNull RunnableCommandTask<ParamType,ResultType> task,
                                @Nullable
                                Duration lifeTimeOfCommandExecution)

Constructor

Parameters:

taskRunner - The runner

task - The task that each commands will run

lifeTimeOfCommandExecution - The duration after which a command can be removed from the manager If null the commands will never expire unless removed manually

Method Detail

addCommand

public ObservableCommandWrapper<ParamType,ResultType> addCommand(@NonNull
                                                                 ParamType param,
                                                                 @NonNull
                                                                 @NonNull StreamObserver<SiLAFramework.CommandConfirmation> observer)
                                                          throws StatusRuntimeException

Add a command to the manager

Parameters:

param - The command parameter

observer - The command confirmation stream observer of the command

Returns:

A wrapped observable command

Throws:

StatusRuntimeException

get

public ObservableCommandWrapper<ParamType,ResultType> get(@NonNull
                                                          SiLAFramework.CommandExecutionUUID executionId)
                                                   throws StatusRuntimeException

Retrieve a command from the manager

Parameters:

executionId - The command identifier

Returns:

The command

Throws:

StatusRuntimeException - if the command does not exist

get

public ObservableCommandWrapper<ParamType,ResultType> get(@NonNull
                                                          @NonNull UUID executionId)
                                                   throws StatusRuntimeException

Retrieve a command from the manager

Parameters:

executionId - The command identifier

Returns:

The command

Throws:

StatusRuntimeException - if the command does not exist

close

public void close()

Close all resources owned by the manager After this call the manager won't be usable anymore

Specified by:

close in interface AutoCloseable

remove

public void remove(@NonNull
                   @NonNull UUID executionId)

Remove a command from the manager