public abstract class AbstractChannelAccessChannel extends java.lang.Object implements ChannelAccessChannel
Abstract base class for ChannelAccessChannel
implementations. This
base class takes care of handling the connection state listeners and of
delegating the various specializations of the get and monitor methods to the
one most generic version.
This class uses a HashSet
to keep all
ChannelAccessConnectionListeners
that
are registered with this channel. Derived classes should call the
updateConnectionState(boolean)
method in order to update the
connection state and notify the listeners. Implementations may choose to
override the
notifyConnectionListener(ChannelAccessConnectionListener, boolean)
method in order to customize the handling of notifications (e.g. catch
certain exceptions possibly thrown by listeners).
All invocations of the various get methods are delegated to the
ChannelAccessChannel.get(ChannelAccessValueType, int)
method, which has to be implemented
by derived classes. All invocations of the various monitor methods are
delegated to the
ChannelAccessChannel.monitor(ChannelAccessValueType, int, ChannelAccessEventMask)
method,
which has to be implemented by derived classes.
Modifier and Type | Field and Description |
---|---|
protected java.lang.Object |
connectionStateLock
Synchronization object that this class synchronizes on when retrieving or
modifying the set of registered listeners.
|
protected ListenerLockPolicy |
listenerLockPolicy
Listener lock-policy used by this channel.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractChannelAccessChannel(ListenerLockPolicy listenerLockPolicy)
Initializes this channel with the specified listener lock-policy.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addConnectionListener(ChannelAccessConnectionListener listener)
Registers a connection state listener with this channel.
|
protected void |
failWaitForConnectionStateFutures()
Fails the waiting connection state futures.
|
ListenableFuture<ChannelAccessAlarmAcknowledgementStatus> |
getAlarmAcknowledgementStatus(int count)
Gets the current value from the channel using the
DBR_STSACK_STRING and
the specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyChar> |
getAlarmChar(int count)
Gets the current value from the channel using the
DBR_STS_CHAR and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyDouble> |
getAlarmDouble(int count)
Gets the current value from the channel using the
DBR_STS_DOUBLE and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyEnum> |
getAlarmEnum(int count)
Gets the current value from the channel using the
DBR_STS_ENUM and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyFloat> |
getAlarmFloat(int count)
Gets the current value from the channel using the
DBR_STS_FLOAT and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyLong> |
getAlarmLong(int count)
Gets the current value from the channel using the
DBR_STS_LONG and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyShort> |
getAlarmShort(int count)
Gets the current value from the channel using the
DBR_STS_SHORT and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyString> |
getAlarmString(int count)
Gets the current value from the channel using the
DBR_STS_STRING and the
specified element count}. |
ListenableFuture<ChannelAccessSimpleOnlyChar> |
getChar(int count)
Gets the current value from the channel using the
DBR_CHAR and the specified
element count}. |
ListenableFuture<ChannelAccessClassName> |
getClassName(int count)
Gets the current value from the channel using the
DBR_CLASS_NAME and the
specified element count}. |
ListenableFuture<ChannelAccessControlsChar> |
getControlsChar(int count)
Gets the current value from the channel using the
DBR_CTRL_CHAR and the
specified element count}. |
ListenableFuture<ChannelAccessControlsDouble> |
getControlsDouble(int count)
Gets the current value from the channel using the
DBR_CTRL_DOUBLE and the
specified element count}. |
ListenableFuture<ChannelAccessGraphicsEnum> |
getControlsEnum(int count)
Gets the current value from the channel using the
DBR_CTRL_ENUM and the
specified element count}. |
ListenableFuture<ChannelAccessControlsFloat> |
getControlsFloat(int count)
Gets the current value from the channel using the
DBR_CTRL_FLOAT and the
specified element count}. |
ListenableFuture<ChannelAccessControlsLong> |
getControlsLong(int count)
Gets the current value from the channel using the
DBR_CTRL_LONG and the
specified element count}. |
ListenableFuture<ChannelAccessControlsShort> |
getControlsShort(int count)
Gets the current value from the channel using the
DBR_CTRL_SHORT and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyString> |
getControlsString(int count)
Gets the current value from the channel using the
DBR_CTRL_STRING and the
specified element count}. |
ListenableFuture<ChannelAccessSimpleOnlyDouble> |
getDouble(int count)
Gets the current value from the channel using the
DBR_DOUBLE and the specified
element count}. |
ListenableFuture<ChannelAccessSimpleOnlyEnum> |
getEnum(int count)
Gets the current value from the channel using the
DBR_ENUM and the specified
element count}. |
ListenableFuture<ChannelAccessSimpleOnlyFloat> |
getFloat(int count)
Gets the current value from the channel using the
DBR_FLOAT and the specified
element count}. |
ListenableFuture<ChannelAccessGraphicsOnlyChar> |
getGraphicsChar(int count)
Gets the current value from the channel using the
DBR_GR_CHAR and the specified
element count}. |
ListenableFuture<ChannelAccessGraphicsOnlyDouble> |
getGraphicsDouble(int count)
Gets the current value from the channel using the
DBR_GR_DOUBLE and the
specified element count}. |
ListenableFuture<ChannelAccessGraphicsEnum> |
getGraphicsEnum(int count)
Gets the current value from the channel using the
DBR_GR_ENUM and the specified
element count}. |
ListenableFuture<ChannelAccessGraphicsOnlyFloat> |
getGraphicsFloat(int count)
Gets the current value from the channel using the
DBR_GR_FLOAT and the
specified element count}. |
ListenableFuture<ChannelAccessGraphicsOnlyLong> |
getGraphicsLong(int count)
Gets the current value from the channel using the
DBR_GR_LONG and the specified
element count}. |
ListenableFuture<ChannelAccessGraphicsOnlyShort> |
getGraphicsShort(int count)
Gets the current value from the channel using the
DBR_GR_SHORT and the
specified element count}. |
ListenableFuture<ChannelAccessAlarmOnlyString> |
getGraphicsString(int count)
Gets the current value from the channel using the
DBR_GR_STRING and the
specified element count}. |
ListenerLockPolicy |
getListenerLockPolicy()
Returns the listener lock-policy used by this channel.
|
ListenableFuture<ChannelAccessSimpleOnlyLong> |
getLong(int count)
Gets the current value from the channel using the
DBR_LONG and the specified
element count}. |
ListenableFuture<ChannelAccessSimpleOnlyShort> |
getShort(int count)
Gets the current value from the channel using the
DBR_SHORT and the specified
element count}. |
ListenableFuture<ChannelAccessSimpleOnlyString> |
getString(int count)
Gets the current value from the channel using the
DBR_STRING and the specified
element count}. |
ListenableFuture<ChannelAccessTimeChar> |
getTimeChar(int count)
Gets the current value from the channel using the
DBR_TIME_CHAR and the
specified element count}. |
ListenableFuture<ChannelAccessTimeDouble> |
getTimeDouble(int count)
Gets the current value from the channel using the
DBR_TIME_DOUBLE and the
specified element count}. |
ListenableFuture<ChannelAccessTimeEnum> |
getTimeEnum(int count)
Gets the current value from the channel using the
DBR_TIME_ENUM and the
specified element count}. |
ListenableFuture<ChannelAccessTimeFloat> |
getTimeFloat(int count)
Gets the current value from the channel using the
DBR_TIME_FLOAT and the
specified element count}. |
ListenableFuture<ChannelAccessTimeLong> |
getTimeLong(int count)
Gets the current value from the channel using the
DBR_TIME_LONG and the
specified element count}. |
ListenableFuture<ChannelAccessTimeShort> |
getTimeShort(int count)
Gets the current value from the channel using the
DBR_TIME_SHORT and the
specified element count}. |
ListenableFuture<ChannelAccessTimeString> |
getTimeString(int count)
Gets the current value from the channel using the
DBR_TIME_STRING and the
specified element count}. |
boolean |
isConnected()
Tells whether this channel is currently connected.
|
boolean |
isConnectedOnce()
Tells whether this channel has been connected at least once.
|
ChannelAccessMonitor<ChannelAccessAlarmAcknowledgementStatus> |
monitorAlarmAcknowledgementStatus(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STSACK_STRING data
type, the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyChar> |
monitorAlarmChar(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_CHAR data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyDouble> |
monitorAlarmDouble(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_DOUBLE data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyEnum> |
monitorAlarmEnum(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_ENUM data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyFloat> |
monitorAlarmFloat(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_FLOAT data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyLong> |
monitorAlarmLong(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_LONG data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyShort> |
monitorAlarmShort(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_SHORT data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyString> |
monitorAlarmString(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STS_STRING data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyChar> |
monitorChar(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CHAR data type, the specified
element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessClassName> |
monitorClassName(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CLASS_NAME data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessControlsChar> |
monitorControlsChar(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_CHAR data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessControlsDouble> |
monitorControlsDouble(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_DOUBLE data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsEnum> |
monitorControlsEnum(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_ENUM data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessControlsFloat> |
monitorControlsFloat(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_FLOAT data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessControlsLong> |
monitorControlsLong(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_LONG data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessControlsShort> |
monitorControlsShort(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_SHORT data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyString> |
monitorControlsString(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_CTRL_STRING data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyDouble> |
monitorDouble(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_DOUBLE data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyEnum> |
monitorEnum(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_ENUM data type, the specified
element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyFloat> |
monitorFloat(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_FLOAT data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsOnlyChar> |
monitorGraphicsChar(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_CHAR data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsOnlyDouble> |
monitorGraphicsDouble(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_DOUBLE data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsEnum> |
monitorGraphicsEnum(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_ENUM data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsOnlyFloat> |
monitorGraphicsFloat(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_FLOAT data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsOnlyLong> |
monitorGraphicsLong(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_LONG data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessGraphicsOnlyShort> |
monitorGraphicsShort(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_SHORT data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessAlarmOnlyString> |
monitorGraphicsString(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_GR_STRING data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyLong> |
monitorLong(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_LONG data type, the specified
element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyShort> |
monitorShort(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_SHORT data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessSimpleOnlyString> |
monitorString(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_STRING data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeChar> |
monitorTimeChar(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_CHAR data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeDouble> |
monitorTimeDouble(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_DOUBLE data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeEnum> |
monitorTimeEnum(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_ENUM data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeFloat> |
monitorTimeFloat(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_FLOAT data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeLong> |
monitorTimeLong(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_LONG data type, the
specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeShort> |
monitorTimeShort(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_SHORT data type,
the specified element count, and the specified event mask. |
ChannelAccessMonitor<ChannelAccessTimeString> |
monitorTimeString(int count,
ChannelAccessEventMask eventMask)
Creates a monitor for this channel using the
DBR_TIME_STRING data type,
the specified element count, and the specified event mask. |
protected void |
notifyConnectionListener(ChannelAccessConnectionListener listener,
boolean nowConnected)
Notifies a connection listener.
|
protected void |
notifyWaitForConnectionStateFutureListener(ListenableFuture<java.lang.Boolean> future,
FutureCompletionListener<? super java.lang.Boolean> listener)
Notifies a completion listener that has been registered with a listenable
future returned by
waitForConnectionState(boolean) . |
boolean |
removeConnectionListener(ChannelAccessConnectionListener listener)
Unregisters a connection state listener from this channel.
|
protected void |
updateConnectionState(boolean nowConnected)
Updates the connection state and notifies the connection state listeners.
|
ListenableFuture<java.lang.Boolean> |
waitForConnectionState(boolean connectionState)
Returns a listenable future that completes when the specified connection
state is established.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
destroy, get, get, getAlarmAcknowledgementStatus, getAlarmChar, getAlarmDouble, getAlarmEnum, getAlarmFloat, getAlarmLong, getAlarmShort, getAlarmString, getChar, getClassName, getClient, getControlsChar, getControlsDouble, getControlsEnum, getControlsFloat, getControlsLong, getControlsShort, getControlsString, getDouble, getEnum, getFloat, getGraphicsChar, getGraphicsDouble, getGraphicsEnum, getGraphicsFloat, getGraphicsLong, getGraphicsShort, getGraphicsString, getLong, getName, getNative, getNative, getNativeCount, getNativeDataType, getServerAddress, getShort, getString, getTimeChar, getTimeDouble, getTimeEnum, getTimeFloat, getTimeLong, getTimeShort, getTimeString, isDestroyed, isMayRead, isMayWrite, monitor, monitor, monitor, monitor, monitorAlarmAcknowledgementStatus, monitorAlarmAcknowledgementStatus, monitorAlarmAcknowledgementStatus, monitorAlarmChar, monitorAlarmChar, monitorAlarmChar, monitorAlarmDouble, monitorAlarmDouble, monitorAlarmDouble, monitorAlarmEnum, monitorAlarmEnum, monitorAlarmEnum, monitorAlarmFloat, monitorAlarmFloat, monitorAlarmFloat, monitorAlarmLong, monitorAlarmLong, monitorAlarmLong, monitorAlarmShort, monitorAlarmShort, monitorAlarmShort, monitorAlarmString, monitorAlarmString, monitorAlarmString, monitorChar, monitorChar, monitorChar, monitorClassName, monitorClassName, monitorClassName, monitorControlsChar, monitorControlsChar, monitorControlsChar, monitorControlsDouble, monitorControlsDouble, monitorControlsDouble, monitorControlsEnum, monitorControlsEnum, monitorControlsEnum, monitorControlsFloat, monitorControlsFloat, monitorControlsFloat, monitorControlsLong, monitorControlsLong, monitorControlsLong, monitorControlsShort, monitorControlsShort, monitorControlsShort, monitorControlsString, monitorControlsString, monitorControlsString, monitorDouble, monitorDouble, monitorDouble, monitorEnum, monitorEnum, monitorEnum, monitorFloat, monitorFloat, monitorFloat, monitorGraphicsChar, monitorGraphicsChar, monitorGraphicsChar, monitorGraphicsDouble, monitorGraphicsDouble, monitorGraphicsDouble, monitorGraphicsEnum, monitorGraphicsEnum, monitorGraphicsEnum, monitorGraphicsFloat, monitorGraphicsFloat, monitorGraphicsFloat, monitorGraphicsLong, monitorGraphicsLong, monitorGraphicsLong, monitorGraphicsShort, monitorGraphicsShort, monitorGraphicsShort, monitorGraphicsString, monitorGraphicsString, monitorGraphicsString, monitorLong, monitorLong, monitorLong, monitorNative, monitorNative, monitorNative, monitorNative, monitorShort, monitorShort, monitorShort, monitorString, monitorString, monitorString, monitorTimeChar, monitorTimeChar, monitorTimeChar, monitorTimeDouble, monitorTimeDouble, monitorTimeDouble, monitorTimeEnum, monitorTimeEnum, monitorTimeEnum, monitorTimeFloat, monitorTimeFloat, monitorTimeFloat, monitorTimeLong, monitorTimeLong, monitorTimeLong, monitorTimeShort, monitorTimeShort, monitorTimeShort, monitorTimeString, monitorTimeString, monitorTimeString, put, putAcknowledgeAlarm, putAcknowledgeAlarmNoCallback, putChar, putChar, putCharNoCallback, putCharNoCallback, putConfigureAcknowledgeTransientAlarms, putConfigureAcknowledgeTransientAlarmsNoCallback, putDouble, putDouble, putDoubleNoCallback, putDoubleNoCallback, putEnum, putEnum, putEnumNoCallback, putEnumNoCallback, putFloat, putFloat, putFloatNoCallback, putFloatNoCallback, putLong, putLong, putLongNoCallback, putLongNoCallback, putNoCallback, putShort, putShort, putShortNoCallback, putShortNoCallback, putString, putString, putString, putStringNoCallback, putStringNoCallback, putStringNoCallback
protected final java.lang.Object connectionStateLock
protected final ListenerLockPolicy listenerLockPolicy
removeConnectionListener(ChannelAccessConnectionListener)
method
and the behavior of the futures returned by
waitForConnectionState(boolean)
. In addition to that, it might
affect the behavior of methods implemented by child classes. Typically,
it will affect the behavior of monitors created by the
ChannelAccessChannel.monitor(ChannelAccessValueType, int, ChannelAccessEventMask)
method and futures returned by the
ChannelAccessChannel.get(ChannelAccessValueType, int)
and
ChannelAccessChannel.put(ChannelAccessPuttableValue)
method.protected AbstractChannelAccessChannel(ListenerLockPolicy listenerLockPolicy)
listenerLockPolicy
- listener lock-policy used by this channel. The lister-lock
policy is used by the
removeConnectionListener(ChannelAccessConnectionListener)
method and by the futures returned from the
waitForConnectionState(boolean)
method. Child classes
might use the policy for additional purposes.protected void failWaitForConnectionStateFutures()
Fails the waiting connection state futures. This method must be called by
the child class when this channel is destroyed.
It is important that it is called after the destroyed flag has been set
(and thus ChannelAccessChannel.isDestroyed()
returns true
) because only
this will ensure that no more futures will be added to the list of
waiting futures.
All waiting connection-state futures complete with an
IllegalStateException
. This way, threads waiting for these
futures can continue. If the futures would not fail, threads waiting on
them would block indefinitely because after being destroyed, this channel
is not going to change its connection state any longer.
protected void updateConnectionState(boolean nowConnected)
Updates the connection state and notifies the connection state listeners.
This method delegates calling each listener to
notifyConnectionListener(ChannelAccessConnectionListener, boolean)
,
so that derived classes can take extra precautions (e.g. catch certain
exceptions thrown by a listener). Accordingly, setting the result of
futures created for calls to the waitForConnectionState(boolean)
method is delegated to the
notifyWaitForConnectionStateFutureListener(ListenableFuture, FutureCompletionListener)
method.
This method should be called by derived classes whenever the connection state of the channel changes.
nowConnected
- true
if the channel is now connected,
false
if it is now disconnected.public ListenerLockPolicy getListenerLockPolicy()
ChannelAccessChannel
ChannelAccessChannel.destroy()
and
ChannelAccessChannel.removeConnectionListener(ChannelAccessConnectionListener)
methods.getListenerLockPolicy
in interface ChannelAccessChannel
protected void notifyConnectionListener(ChannelAccessConnectionListener listener, boolean nowConnected)
listener
- the listener that should be notified. Notification should
happen by calling the listeners
completed()
method, passing a reference to this future
instance.nowConnected
- true
if the channel is now connected,
false
if it is now disconnected.protected void notifyWaitForConnectionStateFutureListener(ListenableFuture<java.lang.Boolean> future, FutureCompletionListener<? super java.lang.Boolean> listener)
Notifies a completion listener that has been registered with a listenable
future returned by waitForConnectionState(boolean)
.
This method can be overridden in order to modify how the listener is called. For example, some implementations might want to catch certain exceptions thrown by a listener.
future
- future that was returned by
waitForConnectionState(boolean)
that completed.listener
- listener that has been registered with the future
and shall be notify. This method must call the listener's
completed(...)
method, passing the
future
.public boolean isConnected()
ChannelAccessChannel
isConnected
in interface ChannelAccessChannel
true
if the channel is currently connected,
false
if it is currently disconnected.ChannelAccessChannel.isConnectedOnce()
public boolean isConnectedOnce()
ChannelAccessChannel
isConnectedOnce
in interface ChannelAccessChannel
true
if this channel is currently connected or has
previously been connected, false
otherwise.ChannelAccessChannel.isConnected()
public boolean addConnectionListener(ChannelAccessConnectionListener listener)
ChannelAccessChannel
Registers a connection state listener with this channel. The listener will be notified when this channel's connection state changes. When the listener is added, it is called once to notify it of the current connection state.
If the specified listener is already registered with this channel, no
action is taken and this method returns false
.
Important note: Typically, the listener is executed by
the thread that performs network I/O. For this reason, it is important
that the listener does not block or perform any long-running operations.
Instead, the listener should delegate any such operation to a different
thread (e.g. using an Executor
). Any violation of this rule might
result in unexpected or unpredictable behavior. In particular, a blocking
listener might cause a dead-lock, which results in the whole Channel
Access client being stalled indefinitely.
If the calling code is not interested in receiving permanent status
updates and only wants to wait for a certain connection state to be
established, ChannelAccessChannel.waitForConnectionState(boolean)
might be a simpler
alternative to this method.
addConnectionListener
in interface ChannelAccessChannel
listener
- listener to be registered with this channel. Must not be
null
.true
if the listener has been added,
false
if the listener has already been added
earlier.ChannelAccessChannel.removeConnectionListener(ChannelAccessConnectionListener)
,
ChannelAccessChannel.waitForConnectionState(boolean)
public boolean removeConnectionListener(ChannelAccessConnectionListener listener)
ChannelAccessChannel
Unregisters a connection state listener from this channel. The exact behavior of this method depends on the listener lock-policy used by this channel.
If the BLOCK
policy is in effect, the
listener is not going to receive another notification after this method
returns. If the IGNORE
policy is in
effect, the listener might be notified once more after this method
returns. If the REPORT
policy is in
effect, this method throws a ConcurrentNotificationException
if
the listener might be notified once more. The listener is still removed,
despite the exception being thrown.
If the specified listener has already been removed from this channel or
has never been added, no action is taken and this method returns
false
.
removeConnectionListener
in interface ChannelAccessChannel
listener
- listener to be unregistered from this channel.true
if the listener has been removed,
false
if the listener has already been removed
earlier or if it has never been added.ChannelAccessChannel.addConnectionListener(ChannelAccessConnectionListener)
,
ChannelAccessChannel.getListenerLockPolicy()
public ListenableFuture<java.lang.Boolean> waitForConnectionState(boolean connectionState)
ChannelAccessChannel
Returns a listenable future that completes when the specified connection state is established. This method can be used if certain actions are to be delayed until the channel is connected or disconnected.
If the channel is already in the specified connection state, the future returned by this method completes immediately.
Due to the asynchronous nature of connection events, there is no guarantee that the channel is still in the specified connection state when the future has completed. It is possible that the channel again changed its state after first switching to the desired state. If the code waiting for the future detects such a situation, it should simply make another call to this method to wait for the connection state to change again.
waitForConnectionState
in interface ChannelAccessChannel
connectionState
- desired connection state. If true
, the future
returned by this method completes when the channel is
connected. If false
, the future returned by this
method completes when the channel is disconnected.connectionState
. If the channel already is
in the specified connectionState
, the future
completes immediately. The completed future's value will be the
connection state at the time when it completed (always the
specified connectionState
).public ListenableFuture<ChannelAccessSimpleOnlyString> getString(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STRING
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyString> getAlarmString(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_STRING
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeString> getTimeString(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_STRING
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyString> getGraphicsString(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_STRING
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyString> getControlsString(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_STRING
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessSimpleOnlyShort> getShort(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_SHORT
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyShort> getAlarmShort(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_SHORT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeShort> getTimeShort(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_SHORT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsOnlyShort> getGraphicsShort(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_SHORT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessControlsShort> getControlsShort(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_SHORT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessSimpleOnlyFloat> getFloat(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_FLOAT
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyFloat> getAlarmFloat(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_FLOAT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeFloat> getTimeFloat(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_FLOAT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsOnlyFloat> getGraphicsFloat(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_FLOAT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessControlsFloat> getControlsFloat(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_FLOAT
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessSimpleOnlyEnum> getEnum(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_ENUM
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyEnum> getAlarmEnum(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_ENUM
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeEnum> getTimeEnum(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_ENUM
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsEnum> getGraphicsEnum(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_ENUM
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsEnum> getControlsEnum(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_ENUM
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessSimpleOnlyChar> getChar(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CHAR
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyChar> getAlarmChar(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_CHAR
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeChar> getTimeChar(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_CHAR
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsOnlyChar> getGraphicsChar(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_CHAR
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessControlsChar> getControlsChar(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_CHAR
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessSimpleOnlyLong> getLong(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_LONG
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyLong> getAlarmLong(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_LONG
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeLong> getTimeLong(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_LONG
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsOnlyLong> getGraphicsLong(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_LONG
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessControlsLong> getControlsLong(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_LONG
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessSimpleOnlyDouble> getDouble(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_DOUBLE
and the specified
element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmOnlyDouble> getAlarmDouble(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STS_DOUBLE
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessTimeDouble> getTimeDouble(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_TIME_DOUBLE
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getTimeDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessGraphicsOnlyDouble> getGraphicsDouble(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_GR_DOUBLE
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getGraphicsDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessControlsDouble> getControlsDouble(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CTRL_DOUBLE
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getControlsDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessAlarmAcknowledgementStatus> getAlarmAcknowledgementStatus(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_STSACK_STRING
and
the specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getAlarmAcknowledgementStatus
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ListenableFuture<ChannelAccessClassName> getClassName(int count)
ChannelAccessChannel
Gets the current value from the channel using the
DBR_CLASS_NAME
and the
specified element count}.
Due to a get operation's asynchronous nature, the result is not returned right away, but a future that can be used to wait on the operation and get its result is returned.
Errors are typically indicated by an exception that is wrapped in an
ExecutionException
that is thrown by the future. Only errors in
the parameters to this method or a destroyed channel will result in an
immediate exception thrown by this method.
getClassName
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the get operation only returns the number of elements
that is equal to the channel's native element count.public ChannelAccessMonitor<ChannelAccessSimpleOnlyString> monitorString(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STRING
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyString> monitorAlarmString(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_STRING
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeString> monitorTimeString(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_STRING
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyString> monitorGraphicsString(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_STRING
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyString> monitorControlsString(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_STRING
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsString
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessSimpleOnlyShort> monitorShort(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_SHORT
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyShort> monitorAlarmShort(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_SHORT
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeShort> monitorTimeShort(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_SHORT
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsOnlyShort> monitorGraphicsShort(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_SHORT
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessControlsShort> monitorControlsShort(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_SHORT
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsShort
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessSimpleOnlyFloat> monitorFloat(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_FLOAT
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyFloat> monitorAlarmFloat(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_FLOAT
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeFloat> monitorTimeFloat(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_FLOAT
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsOnlyFloat> monitorGraphicsFloat(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_FLOAT
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessControlsFloat> monitorControlsFloat(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_FLOAT
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsFloat
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessSimpleOnlyEnum> monitorEnum(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_ENUM
data type, the specified
element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyEnum> monitorAlarmEnum(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_ENUM
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeEnum> monitorTimeEnum(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_ENUM
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsEnum> monitorGraphicsEnum(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_ENUM
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsEnum> monitorControlsEnum(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_ENUM
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsEnum
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessSimpleOnlyChar> monitorChar(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CHAR
data type, the specified
element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyChar> monitorAlarmChar(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_CHAR
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeChar> monitorTimeChar(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_CHAR
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsOnlyChar> monitorGraphicsChar(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_CHAR
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessControlsChar> monitorControlsChar(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_CHAR
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsChar
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessSimpleOnlyLong> monitorLong(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_LONG
data type, the specified
element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyLong> monitorAlarmLong(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_LONG
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeLong> monitorTimeLong(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_LONG
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsOnlyLong> monitorGraphicsLong(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_LONG
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessControlsLong> monitorControlsLong(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_LONG
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsLong
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessSimpleOnlyDouble> monitorDouble(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_DOUBLE
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmOnlyDouble> monitorAlarmDouble(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STS_DOUBLE
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessTimeDouble> monitorTimeDouble(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_TIME_DOUBLE
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorTimeDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessGraphicsOnlyDouble> monitorGraphicsDouble(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_GR_DOUBLE
data type, the
specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorGraphicsDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessControlsDouble> monitorControlsDouble(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CTRL_DOUBLE
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorControlsDouble
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessAlarmAcknowledgementStatus> monitorAlarmAcknowledgementStatus(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_STSACK_STRING
data
type, the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorAlarmAcknowledgementStatus
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.public ChannelAccessMonitor<ChannelAccessClassName> monitorClassName(int count, ChannelAccessEventMask eventMask)
ChannelAccessChannel
Creates a monitor for this channel using the
DBR_CLASS_NAME
data type,
the specified element count, and the specified event mask.
A monitor can be created for a channel that is currently disconnected (or has not yet been connected). However, the monitor will only post events when the channel is connected.
Errors are typically indicated by calling the monitor listeners'
monitorError(...)
method. Only errors in the parameters to this method
or a destroyed channel will result in an immediate exception thrown by
this method.
monitorClassName
in interface ChannelAccessChannel
count
- number of elements to request from the server. Must be
positive or zero. A value of zero is interpreted as the
channel's native element count.
If the specified number exceeds the channel's native element
count, the monitor event will only provide the number of
elements that is equal to the channel's native element count.eventMask
- event mask to use for the monitor. The event mask specifies
which events on the server will trigger a monitor event. If
null
, the
default event mask is used.Copyright © 2014–2019 aquenos GmbH. All rights reserved.