Base class for receiving events when a Grabba device is connected or disconnected.
The following events are supported by this class:
Each event may invoke callbacks in two ways:
By default, each listener object will receive event notifications from the driver for its entire lifetime; the enable() and disable() methods may be used if control is required over whether notifications are received.
The default behaviour for each event, if not overridden, on an enabled listener object is as follows:
Overrides need not call the superclass' equivalent method unless it is necessary to preserve the delegation (i.e. to support both subclassing and delegation from a single object).
Thread safety: This class is intended to be thread-safe; any classes deriving from it should ensure that the relevant methods are callable from any thread.
Public Member Functions | |
ConnectionListener () | |
Default constructor - builds a listener object then enables receipt of events from the driver. | |
ConnectionListener (boolean startEnabled) | |
Constructor - builds a listener object then optionally enables receipt of events from the driver. More... | |
void | connectEvent () |
Callback which is invoked when a Grabba device is connected. More... | |
final void | disable () |
Disable receipt of events from the driver by this object. More... | |
void | disconnectEvent () |
Callback which is invoked when a Grabba device is disconnected. More... | |
final void | enable () |
Enable receipt of events from the driver by this object. More... | |
final void | setDelegate (Delegate newDelegate) |
Set the delegate which will receive event callbacks if default listener behaviour is not overridden. More... | |
ConnectionListener | ( | boolean | startEnabled | ) |
Constructor - builds a listener object then optionally enables receipt of events from the driver.
startEnabled | If set, the listener object is enabled immediately (equivalent of default constructor), otherwise it is disabled until the first call to enable() |
void connectEvent | ( | ) |
Callback which is invoked when a Grabba device is connected.
This method will be triggered by the driver when it establishes a connection to a Grabba device, providing the listener object is enabled.
Override this method to receive callbacks when the object is enabled (at construction or via enable()) and the event is triggered.
Implements ConnectionInterface.
|
inherited |
Disable receipt of events from the driver by this object.
This has no effect if the object was already disabled.
void disconnectEvent | ( | ) |
Callback which is invoked when a Grabba device is disconnected.
This method will be triggered by the driver when it loses an established connection to a Grabba device, regardless of the reasons, providing the listener object is enabled.
Override this method to receive callbacks when the object is enabled (at construction or via enable()) and the event is triggered.
Implements ConnectionInterface.
|
inherited |
Enable receipt of events from the driver by this object.
This has no effect if the object was already enabled.
|
inherited |
Set the delegate which will receive event callbacks if default listener behaviour is not overridden.
Delegation may alternatively be disabled by providing a null reference here.
newDelegate | If null, disables delegation; if non-null, enables delegation and sets the delegate to the supplied object. |