Package com.smartgridready.communicator.async.process

Class WriteExec<V>

java.lang.Object

com.smartgridready.communicator.async.process.Processor

com.smartgridready.communicator.async.process.WriteExec<V>

Type Parameters:

V - The type of value to write.

All Implemented Interfaces:

Executable

public class WriteExec<V>
extends Processor
implements Executable

Implements an asynchronous read method.

Constructor Summary

Constructors

Constructor	Description
WriteExec(java.lang.String functionalProfileName, java.lang.String dataPointName, WriteFunction<V> writeFunction)	Constructs a new instance.
WriteExec(java.lang.String functionalProfileName, java.lang.String dataPointName, WriteFunction<V> writeFunction, io.reactivex.rxjava3.core.Scheduler scheduler)	Constructs a new instance with a custom scheduler.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleans up disposable resources.
ExecStatus	getExecStatus()	Gets the execution status.
java.lang.Throwable	getExecThrowable()	Gets the exception that was thrown.
java.time.Instant	getRequestTime()	Gets the time stamp of sending the request.
java.time.Instant	getResponseTime()	Gets the time stamp of receiving the response.
AsyncResult<V>	getResult()	Gets the process result.
void	process(ProcessingType processingType)	Executes the processes.
void	setFinishedNotificationReceiver(java.lang.Object notificationReceiver)	Sets an object which should receive notifications of status changes.
void	setWriteValue(V value)	Sets the value to write.
java.lang.String	toString()

Methods inherited from class com.smartgridready.communicator.async.process.Processor

await, process

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteExec

public WriteExec(java.lang.String functionalProfileName,
                 java.lang.String dataPointName,
                 WriteFunction<V> writeFunction)

Constructs a new instance.

Parameters:

functionalProfileName - the functional profile name

dataPointName - the data point name

writeFunction - a reference to the actual method to be called

WriteExec

public WriteExec(java.lang.String functionalProfileName,
                 java.lang.String dataPointName,
                 WriteFunction<V> writeFunction,
                 io.reactivex.rxjava3.core.Scheduler scheduler)

Constructs a new instance with a custom scheduler.

Parameters:

functionalProfileName - the functional profile name

dataPointName - the data point name

writeFunction - a reference to the actual method to be called

scheduler - a task scheduler

Method Detail

process

public void process(ProcessingType processingType)

Description copied from class: Processor

Executes the processes.

Specified by:

process in class Processor

Parameters:

processingType - the type of execution

setWriteValue

public void setWriteValue(V value)

Sets the value to write.

Parameters:

value - a value

getResult

public AsyncResult<V> getResult()

Description copied from interface: Executable

Gets the process result.

Specified by:

getResult in interface Executable

Returns:

an instance of AsyncResult with generic type

getExecStatus

public ExecStatus getExecStatus()

Gets the execution status.

Specified by:

getExecStatus in interface Executable

Returns:

an instance of ExecStatus

getExecThrowable

public java.lang.Throwable getExecThrowable()

Gets the exception that was thrown.

Returns:

an instance of Throwable

getRequestTime

public java.time.Instant getRequestTime()

Gets the time stamp of sending the request.

Returns:

an instance of Instant

getResponseTime

public java.time.Instant getResponseTime()

Gets the time stamp of receiving the response.

Returns:

an instance of Instant

cleanup

public void cleanup()

Cleans up disposable resources.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setFinishedNotificationReceiver

public void setFinishedNotificationReceiver(java.lang.Object notificationReceiver)

Description copied from interface: Executable

Sets an object which should receive notifications of status changes.

Specified by:

setFinishedNotificationReceiver in interface Executable

Parameters:

notificationReceiver - the receiving object