com.prosysopc.ua.pubsub

Class PubSubSystemCommands

java.lang.Object

com.prosysopc.ua.pubsub.PubSubSystemCommands

All Implemented Interfaces:

PubSubConnectionCommands, PubSubMqttConnectionCommands

public class PubSubSystemCommands
extends Object
implements PubSubConnectionCommands, PubSubMqttConnectionCommands

Holds all command types for a PubSubSystem as static constants, and contains methods to execute those commands. This class is considered to be sealed, instances are only obtained via PubSubSystem.commands().

Field Summary

Fields

Modifier and Type	Field and Description
static PubSubSystemCommandType<PubSubSystemConfToUaBinaryFileCommand,UaBinaryFile>	INTERNAL_PUB_SUB_SYSTEM_CONF_TO_UABINARYFILE Internal prototype PubSubSystemCommand to generate a UaBinaryFile of the current live configuration.

Fields inherited from interface com.prosysopc.ua.pubsub.PubSubConnectionCommands

PUB_SUB_RESTART_CONNECTION, PUB_SUB_SEND_DATA_SET_FIELDS, PUB_SUB_SEND_KEY_FRAME

Fields inherited from interface com.prosysopc.ua.pubsub.PubSubMqttConnectionCommands

INTERNAL_PUB_SUB_MQTT_SEND_MESSAGE

Method Summary

Modifier and Type	Method and Description
<C extends PubSubSystemCommand<R>,R> CompletableFuture<R>	createAndExecute(PubSubSystemCommandType<C,R> commandType, Function<PubSubSystemConf,C> commandProvider) Creates and executes a command based on the current configuration.
<C extends PubSubSystemCommand<R>,R> CompletableFuture<R>	execute(PubSubSystemCommandType<C,R> commandType, C command) Executes the given command (at some point in the future, typically effectively immediately, possibly before this method returns).
void	sendDataSetFields(String connectionName, String writerGroupName, String writerName, Iterable<String> fieldNames) Forces the given Writer (of the given group of the given connection) to include the given fields the next time it would send a DataSet message, even if the given fields have not changed.
void	sendKeyFrame(String connectionName, String writerGroupName, String writerName) Forces the given Writer (of the given group of the given connection) to send a KeyFrame (DataSet message with all field values set) the next time it would send a DataSet message, even if not all field values have changed.

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_PUB_SUB_SYSTEM_CONF_TO_UABINARYFILE

public static final PubSubSystemCommandType<PubSubSystemConfToUaBinaryFileCommand,UaBinaryFile> INTERNAL_PUB_SUB_SYSTEM_CONF_TO_UABINARYFILE

Internal prototype PubSubSystemCommand to generate a UaBinaryFile of the current live configuration.

Method Detail

createAndExecute

public <C extends PubSubSystemCommand<R>,R> CompletableFuture<R> createAndExecute(PubSubSystemCommandType<C,R> commandType,
                                                                                  Function<PubSubSystemConf,C> commandProvider)

Creates and executes a command based on the current configuration. If the given function returns null, the command is considered canceled, and the returned CompletableFuture is completed exceptionally with CancellationException.

The given function will get the current live configuration as it's parameter. If the configuration is no longer suitable for the action, you can return null, in which case the returned CompletableFuture is also internally canceled.

The PubSubSystemCommand created by the given function will be executed at some point in the future, but it might also have been completed by the time this method returns.

execute

public <C extends PubSubSystemCommand<R>,R> CompletableFuture<R> execute(PubSubSystemCommandType<C,R> commandType,
                                                                         C command)

Executes the given command (at some point in the future, typically effectively immediately, possibly before this method returns). The given command types (PubSubSystemCommandType) can be found as static constants in this class (PubSubSystemCommands), and the command instances created with respective classes static build() method, such as PubSubSendKeyframeCommand.builder().

Note that the configuration of the PubSubSystem could have changed in-between calling this method and the command being executed internally. If this is of concern, the createAndExecute(PubSubSystemCommandType, Function) can be used to generate the command more related to the actual live configuration at the time it would have been executed.

This method will will effectively behave the same as createAndExecute(commandType, conf -> command);, i.e. effectively the current live configuration info is ignored.

sendDataSetFields

public void sendDataSetFields(String connectionName,
                              String writerGroupName,
                              String writerName,
                              Iterable<String> fieldNames)
                       throws PubSubException

Forces the given Writer (of the given group of the given connection) to include the given fields the next time it would send a DataSet message, even if the given fields have not changed.

This method is a convenience method to calling createAndExecute(PubSubSystemCommandType, Function) with PubSubConnectionCommands.PUB_SUB_SEND_DATA_SET_FIELDS and calling CompletableFuture.get() on the return. If CompletableFuture.get() throws and it was due to a PubSubException, it is re-thrown directly, otherwise the exception is wrapped in the PubSubException.

Throws:

PubSubException

sendKeyFrame

public void sendKeyFrame(String connectionName,
                         String writerGroupName,
                         String writerName)
                  throws PubSubException

Forces the given Writer (of the given group of the given connection) to send a KeyFrame (DataSet message with all field values set) the next time it would send a DataSet message, even if not all field values have changed.

This method is a convenience method to calling createAndExecute(PubSubSystemCommandType, Function) with PubSubConnectionCommands.PUB_SUB_SEND_KEY_FRAME and calling CompletableFuture.get() on the return. If CompletableFuture.get() throws and it was due to a PubSubException, it is re-thrown directly, otherwise the exception is wrapped in the PubSubException.

Throws:

PubSubException