DaaSAPI
Complete reference for the DaasAPI C++ class — the main entry point of the DaaS-IoT SDK.
DaasAPI is the main class of the DaaS-IoT library. DIN = device identifier, SID = network/system identifier. ERROR_NONE indicates success. Some methods are marked 'not implemented yet' in this version.
getVersion
const char* getVersion()Get the DaaS API library version.
A string with the DaaS API library version.
getBuildInfo
const char* getBuildInfo()Get build information of the DaaS API library.
A string with build info (compiler version, build config).
listAvailableDrivers
const char* listAvailableDrivers()List all available drivers in the DaaS stack for this node.
A semicolon-separated string of available drivers.
doEnd
daas_error_t doEnd()Release resources and deactivate the node.
ERROR_NONE on success, or an error code on failure.
doReset
daas_error_t doReset()Reset the local node, clear all resources and disconnect from the current network.
ERROR_NONE on success, or an error code on failure.
doInit
daas_error_t doInit(din_t sid, din_t din)Initialize services and resources for the local node. Initialization is no longer strictly necessary: without din/sid the node can auto-generate them via discovery.
sid SID of the local nodedin DIN of the local nodeERROR_NONE on success, or an error code on failure.
doPerform
daas_error_t doPerform(performs_mode_t mode)Execute the node's main processing loop (real-time or multi-threading). Must be called for the node to be operational. In threading mode call once; in real-time mode call cyclically.
mode PERFORM_CORE_THREAD for multi-threading mode, PERFORM_CORE_NO_THREAD for real-time modeERROR_NONE on success, or an error code on failure.
enableDriver
daas_error_t enableDriver(link_t driver_id, const char* local_uri)Configure a driver for a network technology (link).
driver_id communication technology to enable: _LINK_INET4, _LINK_BLUETOOTH, and others in link_tlocal_uri physical address of the local node. INET4: "IP:PORT" e.g. "192.168.1.2:4000". BLUETOOTH: a BT address e.g. "00:1A:7D:DA:71:13:CHANNEL"ERROR_NONE on success, or an error code on failure.
getStatus
nodestate_t getStatus()Return the status of the local node.
The status of the local node (hardware version, linked channels, sync status, security policy, etc.).
setAcceptRequestsLevel
void setAcceptRequestsLevel(int policy_level)Set which incoming requests the local node accepts.
policy_level 0: accept only from known DINs in the same network. 1: accept from known DINs across networks and same network. 2: accept from all DINs including unknown. Default 1; during discovery it's temporarily set to 2.void
storeConfiguration
bool storeConfiguration(IDepot* storage_interface)Save the current configuration to a storage interface (IDepot).
storage_interface the interface to save the configuration to (filesystem, database, etc.)true if the backup was successful, false otherwise.
loadConfiguration
bool loadConfiguration(IDepot* storage_interface)Load configuration from a storage interface (IDepot). Implement IDepot with open/close/save/load/trash/clearSpace/getSpaceInfo.
storage_interface the interface to load the configuration from (filesystem, database, etc.)true if the configuration was loaded successfully, false otherwise.
doStatisticsReset
bool doStatisticsReset()Reset the system's statistics data.
true if the reset was successful, false otherwise.
getSystemStatistics
uint64_t getSystemStatistics(syscode_t label)Return statistics of the local node for a specific system code.
label the system code to get statistics for (e.g. _cor_dme_sended)The system statistics for the given label.
map
daas_error_t map(din_t din)map(din_t din, link_t link, const char* suri)map(din_t din, link_t link, const char* suri, const char* skey)Map a remote node to the local instance to establish communication. Has 3 overloads. Supported links depend on build config; check listAvailableDrivers().
din DIN of the node to maplink communication technology: _LINK_INET4, _LINK_BLUETOOTH, etc. (optional)suri physical address. INET4: "IP:PORT"; BLUETOOTH: BT address (optional)skey security key for the node (currently not implemented) (optional)ERROR_NONE on success, or an error code on failure.
remove
daas_error_t remove(din_t din)Remove a node from the local instance and clean up associated resources.
din DIN of the node to removeERROR_NONE on success, or an error code on failure.
discovery
daas_error_t discovery()discovery(link_t link)Start a discovery process to locate nodes, broadcasting the enabled drivers' URI to auto-map this node to remote ones. Reception cannot be controlled, only disabled.
link the link to use for discovery; if omitted, all available links are used (optional)ERROR_NONE on success, or an error code on failure.
setDiscoveryState
void setDiscoveryState(discovery_state_t mode)Configure how the node interacts with network discovery (search, host, or stay invisible).
mode discovery_off (disabled), discovery_sender_only (search only), discovery_receiver_only (host only), discovery_full (bidirectional). Default after init is discovery_sender_only.void
listNodes
dinlist_t listNodes()Return map entries (known nodes) in the local instance.
A list of known nodes (din_t) in the local instance.
locate
daas_error_t locate(din_t din, int timeout=1000)Start a process to locate a node if it is not in the known table.
din DIN of the node to locatetimeout max time to wait in ms (default 1000)ERROR_NONE if the node is known, or an error code if not.
sendStatus
daas_error_t sendStatus(din_t din)Send the local node's status to a remote node.
din DIN of the remote node to send the status toERROR_NONE on success, or an error code on failure.
status
const nodestate_t& status(din_t din)Fetch the status of a remote node.
din DIN of the remote node to fetch the status fromThe nodestate_t of the remote node.
fetch
const nodestate_t& fetch(din_t din, uint16_t opts)Fetch the status of a remote node and update it in the local instance.
din DIN of the remote node to fetch the status fromopts options for fetchingThe nodestate_t of the remote node after fetching.
getSyncedTimestamp
uint64_t getSyncedTimestamp()Time with ATS correction, used to communicate inside the DaaS network. Only meaningful when connected and ATS in sync.
The synced timestamp of the local node. Returns local system time without ATS correction if not synchronized.
unlock
const nodestate_t& unlock(din_t din, const char* skey)Unlock a remote node by setting its security key.
din DIN of the remote node to unlockskey the security key to setThe nodestate_t of the remote node after unlocking.
lock
const nodestate_t& lock(const char* skey, unsigned policy_)Set SKEY and security policy for the local node.
skey the security key to setpolicy_ the security policy to setThe nodestate_t of the local node after setting key and policy.
syncNode
const nodestate_t& syncNode(din_t din, unsigned timezone)Set local system time on a remote node and synchronize ATS.
din DIN of the remote node to synchronizetimezone timezone offset in secondsThe nodestate_t of the remote node after synchronization.
syncNet
const nodestate_t& syncNet(din_t din, unsigned bubble_time)Set local system time on a remote node and synchronize ATS.
din DIN of the remote node to synchronizebubble_time max error allowed for synchronization in msThe nodestate_t of the remote node after synchronization.
setATSMaxError
void setATSMaxError(int32_t error)Set the maximum error allowed for ATS synchronization (acceptable time deviation between nodes).
error the maximum error in milliseconds (default 100ms)void
use
bool use(din_t din)Start a real-time session with a remote node.
din DIN of the remote node to start the session withtrue if the RT session was successfully started, false otherwise. (OPEN CONNECTION!)
end
bool end(din_t din)End a real-time session with a remote node.
din DIN of the remote node to end the session withtrue if the RT session was successfully ended, false otherwise.
send
unsigned send(din_t din, unsigned char* outbound, unsigned size)Send data to a remote node in a real-time session.
din DIN of the remote node to send data tooutbound pointer to the data to sendsize size of the data to sendThe size of data sent.
received
unsigned received(din_t din)Check if there is data available from a remote node in a real-time session.
din DIN of the remote node to check for dataThe size of data received.
receive
unsigned receive(din_t din, unsigned char& inbound, unsigned max_size)Receive data from a remote node in a real-time session.
din DIN of the remote node to receive data frominbound reference to a variable that will hold the received datamax_size maximum size of data to receiveThe size of data received.
listTypesets
tsetlist_t& listTypesets()Return a list of user-defined typesets.
A reference to the list of user-defined typesets (Vector of typeset).
pull
daas_error_t pull(din_t din, DDO** inboundDDO)Pull a DDO from a remote node.
din DIN of the remote node to pull data frominboundDDO pointer to a DDO pointer that will hold the pulled DDOERROR_NONE on success, or an error code on failure.
push
daas_error_t push(din_t din, DDO* outboundDDO)Push a DDO to a remote node.
din DIN of the remote node to send data tooutboundDDO pointer to the DDO to sendERROR_NONE on success, or an error code on failure.
availablesPull
daas_error_t availablesPull(din_t din, uint32_t& count)Check if there are available DDOs from a remote node. See also: pull.
din DIN of the remote node to check for available DDOscount reference to a variable that will hold the number of available DDOsERROR_NONE on success, or an error code on failure.
addTypeset
daas_error_t addTypeset(const uint16_t typeset_code, const typeset_fun fun)Map a user-defined typeset to a handler function; the handler is called when a DDO of that typeset is received. Note: a registered typeset does not trigger the received-DDO event.
typeset_code the code of the typeset to addfun the function to handle received DDOs of this typesetERROR_NONE on success, or an error code on failure.
frisbee
daas_error_t frisbee(din_t din)Ping a remote node to check its availability.
din DIN of the remote node to pingERROR_NONE on success, or an error code on failure.
frisbeeICMP
daas_error_t frisbeeICMP(din_t din, uint32_t timeout, uint32_t retry)Ping a remote node with a specified timeout and retry count.
din DIN of the remote node to pingtimeout max time to wait for a reply in msretry number of retries if no reply is receivedERROR_NONE on success, or an error code on failure.
frisbeeDPERF
daas_error_t frisbeeDPERF(din_t din, uint32_t sender_pkt_total=10, uint32_t block_size=1024*1024, uint32_t sender_trip_period=0)Measure the performance of data transfer to a remote node.
din DIN of the remote node to pingsender_pkt_total total number of packets to send (default 10)block_size size of each packet in bytes (default 1MB)sender_trip_period time between packets in ms (default 0)ERROR_NONE on success, or an error code on failure.
getFrisbeeResultDPERF
dperf_info_result getFrisbeeResultDPERF()Return the result of a frisbee DPERF performance test.
A dperf_info_result with: sender_first_timestamp, local_end_timestamp, remote_first_timestamp, remote_last_timestamp, remote_pkt_counter, remote_data_counter.
setDDOPolicy
daas_error_t setDDOPolicy(ddo_policy_t policy)Set the DDO policy for handling unsuccessful DDO sends. Retry policies may change send order.
policy ddo_policy_skip_on_failure (skip & delete on failure, default), ddo_policy_retry_on_failure (retry each doPerform cycle), ddo_policy_exponential_backoff_retry_on_failure (retry with exp backoff: 1min doubling up to 1h)ERROR_NONE on success, or an error code on failure.
unbindNetwork
daas_error_t unbindNetwork()Unbind the local node from the current network, closing all open channels. The mapping table is preserved for later rebinding.
ERROR_NONE on success, or an error code on failure.