Package com.smartgridready.communicator.async.process

Class ReadExec<R>

java.lang.Object

com.smartgridready.communicator.async.process.Processor

com.smartgridready.communicator.async.process.ReadExec<R>

Type Parameters:

R - The type of result.

All Implemented Interfaces:

Executable

public class ReadExec<R>
extends Processor
implements Executable

Implements an asynchronous read method.

Constructor Summary

Constructors

Constructor	Description
ReadExec(java.lang.String functionalProfileName, java.lang.String dataPointName, ReadFunction<R> readFunction)	Constructs a new instance.
ReadExec(java.lang.String functionalProfileName, java.lang.String dataPointName, ReadFunction<R> readFunction, 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.
R	getReadValue()	Gets the value of the read result.
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<R>	getResult()	Gets the process result.
void	handleError(java.lang.Throwable t)	Handles an error.
void	handleSuccess(AsyncResult<R> result)	Handles a finished process.
void	process(ProcessingType processingType)	Executes the processes.
void	setFinishedNotificationReceiver(java.lang.Object notificationReceiver)	Sets an object which should receive notifications of status changes.
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

ReadExec

public ReadExec(java.lang.String functionalProfileName,
                java.lang.String dataPointName,
                ReadFunction<R> readFunction)

Constructs a new instance.

Parameters:

functionalProfileName - the functional profile name

dataPointName - the data point name

readFunction - a reference to the actual method to be called

ReadExec

public ReadExec(java.lang.String functionalProfileName,
                java.lang.String dataPointName,
                ReadFunction<R> readFunction,
                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

readFunction - 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

handleSuccess

public void handleSuccess(AsyncResult<R> result)

Handles a finished process.

Parameters:

result - the process result

handleError

public void handleError(java.lang.Throwable t)

Handles an error.

Parameters:

t - the exception that was thrown

getResult

public AsyncResult<R> getResult()

Description copied from interface: Executable

Gets the process result.

Specified by:

getResult in interface Executable

Returns:

an instance of AsyncResult with generic type

getReadValue

public R getReadValue()

Gets the value of the read result.

Returns:

a value

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

cleanup

public void cleanup()

Cleans up disposable resources.

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

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