org.eth.cyril.telemetry

Class TelemetrySender

java.lang.Object

org.eth.cyril.telemetry.TelemetrySender

public final class TelemetrySender
extends java.lang.Object

Handles sending usage data either to a file or to a server. The usage data is gathered by DataGatherer instances. This class is a central access point to telemetry, allowing for it to be turned off or on.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the telemetry sender.
void	deactivate() Deactivates the telemetry sender.
void	flush() Flushes the telemetry sender.
static TelemetrySender	sendToFile(java.util.Collection<DataGatherer> gatherers, java.nio.file.Path file) Creates a new telemetry sender instance which sends its data to a file.
static TelemetrySender	sendToServer(java.util.Collection<DataGatherer> gatherers, java.lang.String hostName, int port) Creates a new telemetry sender instance which sends its data to a server.

Methods inherited from class java.lang.Object

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

Method Detail

sendToServer

public static TelemetrySender sendToServer(java.util.Collection<DataGatherer> gatherers,
                                           java.lang.String hostName,
                                           int port)

Creates a new telemetry sender instance which sends its data to a server.

Parameters:

gatherers - The collection of data gatherers.

hostName - The host name of the server to send the data to.

port - The port of the server to send the data to.

Returns:

A new telemetry sender instance which sends its data to the configured server.

sendToFile

public static TelemetrySender sendToFile(java.util.Collection<DataGatherer> gatherers,
                                         java.nio.file.Path file)

Creates a new telemetry sender instance which sends its data to a file.

Parameters:

gatherers - The collection of data gatherers.

file - The file to send the data to.

Returns:

A new telemetry sender instance which sends its data to the configured server.

activate

public void activate()

Activates the telemetry sender. All DataGatherer instances associated with this sender are also activated, and data is periodically sent to the configured file/server.

deactivate

public void deactivate()

Deactivates the telemetry sender. All DataGatherer instances associated with this sender are also deactivated.

flush

public void flush()

Flushes the telemetry sender. Makes sure that all data stored in the DataGatherer instances is send to the configured file/server.