com.aquenos.cassandra.pvarchiver.controlsystem

Interface ControlSystemChannel

public interface ControlSystemChannel

Control-system side of an archived channel. This interface provides the methods through which the archiver interacts with the control-system-specific side of each archived channel. Methods can be created through the ControlSystemSupport.createChannel(String, java.util.Map, SampleBucketId, SampleListener) method.

Author:

Sebastian Marsching

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the control-system channel.
String	getChannelName() Returns the channel name identifying this channel.
ControlSystemChannelStatus	getStatus() Returns the channel status.

Method Detail

destroy

void destroy()

Destroys the control-system channel. This means that all resources associated with the channel in the control-system library should be freed and no further samples should be sent to the SampleListener associated with this channel. This method should not block, so the destruction should be implemented in an asynchronous way, if blocking operations are required. It is okay if a channel keeps sending samples, even after returning from this method.

getChannelName

String getChannelName()

Returns the channel name identifying this channel. This must be the name that was specified when creating this channel through the ControlSystemSupport.createChannel(String, java.util.Map, SampleBucketId, SampleListener) method.

Returns:

name identifying this channel.

getStatus

ControlSystemChannelStatus getStatus()

Returns the channel status. The state can be connected, disconnected, or error. In the error state, the status can also contain an optional error message.

The error state should be reserved for problems that are non-recoverable (e.g. configuration problems). If the channel is simply temporarily unavailable (e.g. because the corresponding server is not started), the disconnected state should be preferred.

This method never returns null.

Returns:

status of this channel.