public interface NodeConnectorIf
Modifier and Type | Method and Description |
---|---|
ConnectionStatus |
connect(ConnectorCredential credential,
ConnectionProperties props)
This function is called before getItem to ensure connectivity to the device is established.
|
void |
disconnect()
After all getItem calls have completed, this function is called to perform clean up.
|
ConfigResponse |
executeItems(NodeID nodeId,
ConfigItemIf item)
This function is never explicitly called by the framework.
|
ItemResponse |
getItem(NodeID nodeId,
ItemIf item)
This function is called when the framework is querying a device for some data.
|
ItemResponse getItem(NodeID nodeId, ItemIf item) throws java.lang.Exception
nodeId
- The device details to retrieve data for.item
- The type of data to retrieve.java.lang.Exception
ConnectionStatus connect(ConnectorCredential credential, ConnectionProperties props) throws java.lang.Exception
credential
- The device details to perform a connection to.props
- Additional details you can use in the connection logic, e.g. how long you should try until timeout.java.lang.Exception
ConfigResponse executeItems(NodeID nodeId, ConfigItemIf item) throws java.lang.Exception
nodeId
- item
- java.lang.Exception
void disconnect() throws java.lang.Exception
java.lang.Exception