Summary¶
| Members | Descriptions |
|---|---|
namespacedaas::api |
namespace daas::api¶
Summary¶
| Members | Descriptions |
|---|---|
classdaas::api::DaasWrapper |
Convenience wrapper around libdaas.a (DaasAPI). |
structdaas::api::DriverConfig |
Driver configuration entry used by the wrapper when loading from JSON. |
structdaas::api::InterfaceInfo |
Basic information about a system network interface. |
class daas::api::DaasWrapper¶
Convenience wrapper around libdaas.a (DaasAPI).
Unless explicitly stated, returned references mirror the underlying DaasAPI behavior. In particular, see pull for DDO ownership and lifetime.
Summary¶
| Members | Descriptions |
|---|---|
publicDaasWrapper(const char * config,IDaasApiEvent * eventHandler) |
Constructs the wrapper. |
public~DaasWrapper() |
Destroys the wrapper and its DaasAPI instance. |
public std::vector< std::string >getActiveInterfaces() |
|
public std::vector<InterfaceInfo>listSystemInterfaces() |
|
public daas_error_tdoInit(din_t sid,din_t din) |
|
public daas_error_tdoPerform(performs_mode_t mode) |
|
public daas_error_tdoEnd() |
|
public daas_error_tdoReset() |
|
public const char *getVersion() |
|
public const char *getInfos() |
Returns a short "Version: X | Build: Y" string. |
public const char *listAvailableDrivers() |
|
public daas_error_tenableDriver(link_t link,const char * driver) |
|
public daas_error_tsetupNode(din_t sid,din_t din,link_t link,const char * uri) |
|
public daas_error_tsetupNode(const char * setupFilePath) |
|
public nodestate_tgetStatus() |
|
public const nodestate_t &status(din_t din) |
|
public const nodestate_t &fetch(din_t din,uint16_t opts) |
|
public dinlist_tlistNodes() |
|
public boolstoreConfiguration(IDepot * storage_interface) |
|
public boolloadConfiguration(IDepot * storage_interface) |
|
public daas_error_tmap(din_t din) |
|
public daas_error_tmap(din_t din,link_t link,const char * uri) |
|
public daas_error_tmap(din_t din,link_t link,const char * uri,const char * securityKey) |
|
public daas_error_tremove(din_t din) |
|
public daas_error_tlocate(din_t din) |
|
public daas_error_tavailablesPull(din_t din,uint32_t & count) |
|
public daas_error_tpull(din_t din,DDO ** inboundDDO) |
Receives a DDO from a remote node. |
public daas_error_tpush(din_t din,DDO * outboundDDO) |
Sends a DDO to a remote node. |
public daas_error_tfrisbee(din_t din) |
|
public voidsetEventHandler(IDaasApiEvent * event) |
Sets a new event handler for asynchronous callbacks (not owned). |
public std::stringddoPayloadAsString(DDO & ddo) |
Returns the DDO payload as std::string honoring the exact size (no extra '\0'). |
public std::stringddoPayloadAsCString(DDO & ddo) |
Returns the DDO payload as a NUL-terminated string (copy, with trailing '\0'). Useful for legacy printf("%s"). |
public std::stringddoPayloadAsHex(DDO & ddo,size_t max_bytes) |
Returns a hexadecimal representation of the payload (lowercase). |
Members¶
publicDaasWrapper(const char * config,IDaasApiEvent * eventHandler)¶
Constructs the wrapper.
Parameters¶
-
configOptional configuration file path (may be nullptr). -
eventHandlerOptional event handler for DaasAPI callbacks (not owned).
public~DaasWrapper()¶
Destroys the wrapper and its DaasAPI instance.
public std::vector< std::string >getActiveInterfaces()¶
public std::vector<InterfaceInfo>listSystemInterfaces()¶
public daas_error_tdoInit(din_t sid,din_t din)¶
public daas_error_tdoPerform(performs_mode_t mode)¶
public daas_error_tdoEnd()¶
public daas_error_tdoReset()¶
public const char *getVersion()¶
public const char *getInfos()¶
Returns a short "Version: X | Build: Y" string.
Returns¶
Pointer to an internal buffer valid until next call.
public const char *listAvailableDrivers()¶
public daas_error_tenableDriver(link_t link,const char * driver)¶
public daas_error_tsetupNode(din_t sid,din_t din,link_t link,const char * uri)¶
public daas_error_tsetupNode(const char * setupFilePath)¶
public nodestate_tgetStatus()¶
public const nodestate_t &status(din_t din)¶
public const nodestate_t &fetch(din_t din,uint16_t opts)¶
public dinlist_tlistNodes()¶
public boolstoreConfiguration(IDepot * storage_interface)¶
public boolloadConfiguration(IDepot * storage_interface)¶
public daas_error_tmap(din_t din)¶
public daas_error_tmap(din_t din,link_t link,const char * uri)¶
public daas_error_tmap(din_t din,link_t link,const char * uri,const char * securityKey)¶
public daas_error_tremove(din_t din)¶
public daas_error_tlocate(din_t din)¶
public daas_error_tavailablesPull(din_t din,uint32_t & count)¶
public daas_error_tpull(din_t din,DDO ** inboundDDO)¶
Receives a DDO from a remote node.
Parameters¶
-
dinSender DIN. -
inboundDDOOutput pointer set to the received DDO (owned by C++ layer).
Returns¶
daas_error_t error code.
The returned DDO pointer is owned by DaasAPI/libdaas. Do not delete it. Copy/serialize the payload if you need to keep it beyond its lifetime.
public daas_error_tpush(din_t din,DDO * outboundDDO)¶
Sends a DDO to a remote node.
Parameters¶
-
dinDestination DIN. -
outboundDDOPointer to a DDO owned by the caller; must remain valid during the call.
public daas_error_tfrisbee(din_t din)¶
public voidsetEventHandler(IDaasApiEvent * event)¶
Sets a new event handler for asynchronous callbacks (not owned).
public std::stringddoPayloadAsString(DDO & ddo)¶
Returns the DDO payload as std::string honoring the exact size (no extra '\0').
public std::stringddoPayloadAsCString(DDO & ddo)¶
Returns the DDO payload as a NUL-terminated string (copy, with trailing '\0'). Useful for legacy printf("%s").
public std::stringddoPayloadAsHex(DDO & ddo,size_t max_bytes)¶
Returns a hexadecimal representation of the payload (lowercase).
Parameters¶
max_bytesOptional limit (0 = all).
struct daas::api::DriverConfig¶
Driver configuration entry used by the wrapper when loading from JSON.
Summary¶
| Members | Descriptions |
|---|---|
public link_tlink |
Driver/link type (e.g., LINK_INET4). |
public std::stringuri |
Driver URI (e.g., "127.0.0.1:3000"). |
Members¶
public link_tlink¶
Driver/link type (e.g., LINK_INET4).
public std::stringuri¶
Driver URI (e.g., "127.0.0.1:3000").
struct daas::api::InterfaceInfo¶
Basic information about a system network interface.
Summary¶
| Members | Descriptions |
|---|---|
public std::stringname |
Interface name (e.g., "eth0"). |
public std::stringtype |
Interface type (implementation-defined). |
public std::stringstatus |
Interface status (implementation-defined). |
Members¶
public std::stringname¶
Interface name (e.g., "eth0").
public std::stringtype¶
Interface type (implementation-defined).
public std::stringstatus¶
Interface status (implementation-defined).
Generated by Moxygen