Package com.storedobject.core

Class DataDistributor<D>

java.lang.Object

com.storedobject.core.DataDistributor<D>

Type Parameters:

D - The type of data being distributed.

All Implemented Interfaces:

Closeable, AutoCloseable

public class DataDistributor<D>
extends Object
implements Closeable

A thread-safe utility class responsible for distributing data to registered consumers at a regular interval. The data is distributed using a background scheduled task. Consumers are notified through their accept method. Any consumer that throws an exception during data distribution is automatically unregistered.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
DataDistributor()
DataDistributor(int refreshRate)
DataDistributor(D data)	Constructs a DataDistributor with the specified data and a default refresh rate.
DataDistributor(D data, int refreshRate)	Constructs a DataDistributor with the specified data and refresh rate.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the DataDistributor, releasing any resources held by it.
void	dataUpdated()	Updates the last recorded data update time if the current specified time is more recent than the previously recorded update time.
D	getData()	Retrieves the current data being managed by the DataDistributor.
long	getPingTime()	Get the last time a ping was received (GMT).
long	getTime()	Get the last time data was updated (GMT).
void	pingReceived(long time)	Updates the last recorded ping time if the specified time is more recent than the previously recorded ping time.
void	register(Consumer<D> consumer)	Registers a new consumer to receive data updates.
void	setData(D data)	Sets the data to be distributed by the DataDistributor.
void	unregister(Consumer<D> consumer)	Unregisters a previously registered consumer from receiving data updates.

Methods inherited from class java.lang.Object

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

Constructor Details

DataDistributor

public DataDistributor()

DataDistributor

public DataDistributor(int refreshRate)

DataDistributor

public DataDistributor(D data)

Constructs a DataDistributor with the specified data and a default refresh rate. The data is distributed to registered consumers periodically based on the preset interval.

Parameters:

data - The data to be distributed to consumers.

DataDistributor

public DataDistributor(D data,
 int refreshRate)

Constructs a DataDistributor with the specified data and refresh rate. The data is distributed to registered consumers periodically based on the refresh rate.

Parameters:

data - The data to be distributed to consumers.

refreshRate - The interval, in seconds, at which data is distributed. If the value is less than or equal to 0, a default interval of 5 seconds is used.

Method Details

setData

public void setData(D data)

Sets the data to be distributed by the DataDistributor. This method updates the internal state of the DataDistributor to use the specified data during the next distribution cycle.

Parameters:

data - The data to set. This data will be distributed to registered consumers.

getData

public D getData()

Retrieves the current data being managed by the DataDistributor.

Returns:

The data currently managed and distributed by this instance.

close

public void close()

Closes the DataDistributor, releasing any resources held by it. This method cancels the timer used for periodic data distribution, stopping any ongoing or scheduled tasks. After calling this method, the instance is no longer usable for distributing data.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

register

public void register(Consumer<D> consumer)

Registers a new consumer to receive data updates. The registered consumer will be invoked whenever data is distributed by the DataDistributor.

Parameters:

consumer - The consumer to register. This consumer will process the data upon distribution.

unregister

public void unregister(Consumer<D> consumer)

Unregisters a previously registered consumer from receiving data updates. Once unregistered, the consumer will no longer be invoked during data distribution.

Parameters:

consumer - The consumer to unregister. If null, the method does nothing.

dataUpdated

public void dataUpdated()

Updates the last recorded data update time if the current specified time is more recent than the previously recorded update time. This method ensures that the lastUpdate reflects the most recent time at which a data update occurred, allowing tracking of the update state within the DataDistributor.

pingReceived

public void pingReceived(long time)

Updates the last recorded ping time if the specified time is more recent than the previously recorded ping time. This method ensures that the lastPing field reflects the most recent time at which a ping was received.

Parameters:

time - The timestamp of the received ping, in milliseconds.

getTime

public long getTime()

Get the last time data was updated (GMT).

Returns:

Time.

getPingTime

public long getPingTime()

Get the last time a ping was received (GMT).

Returns:

Ping-time.