public interface ControlSystemChannel
ControlSystemSupport.createChannel(String, java.util.Map, SampleBucketId, SampleListener)
method.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.
|
void destroy()
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.String getChannelName()
ControlSystemSupport.createChannel(String, java.util.Map, SampleBucketId, SampleListener)
method.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
.
Copyright © 2011–2017 aquenos GmbH. All rights reserved.