SDK API wrappers
The common library provides wrappers to the SDK APIs. These ensure that the multi-threading nuances are taken care of. This is implemented in apiWrapper file.
Function documentation
AgentApiReturnType common::apiAgentLidListGetNext (void * i_LidListHandle, uint32_t * i_lidNumber, ApiVariableType * i_lidValue)
apiAgentLidListGetNext: This function gets the next lid value pair in a previously created lid list.
Parameters:
|
i_LidListHandle |
pointer to a previously created lid list. |
|
i_lidNumber* |
pointer to memory that will be filled by the next lid number in the list. |
|
i_lidValue* |
pointer to memory that will be filled by the next value in the list. |
Returns:
Returns the API success or failure accordingly.
AgentApiReturnType common::apiGetData (const uint32_t & i_lidNumber, ApiVariableType * i_lidValue)
This is an API wrapper function to retrieve non-periodic LIDs.
Parameters:
|
in |
i_lidNumber |
lid number whose value to be retrieved |
|
out |
i_lidValue |
lid value returned |
Returns:
Returns the API success or failure accordingly.
AgentApiReturnType common::apiLidListResetIteration (void * i_LidListHandle)
apiLidListResetIteration: This function resets the iteration on a lid list. MUST BE USED after lid list is used for other purposes.
Parameters:
|
i_LidListHandle* |
pointer to a previously created lid list. |
Returns:
Returns the API success or failure accordingly.
AgentApiReturnType common::apiLogHistEvt (const uint32_t & i_eventId, const char * i_eventData, const uint32_t & i_eventDataLength, const uint32_t & i_featureId, const bool & i_sendAsAlarm)
This API wrapper function is used by agents to log an event.
Parameters:
|
in |
i_eventId |
event id |
|
in |
i_eventData |
data string to be added |
|
in |
i_eventDataLength |
length of the data string |
|
in |
i_featureId |
feature if |
|
in |
i_sendAsAlarm |
send the event as alarm or not? |
Returns:
Returns the API success or failure accordingly.
AgentApiReturnType common::apiLogHistEvtWithTimeStamp (const uint32_t & i_eventId, const char * i_eventData, const uint32_t & i_eventDataLength, const uint32_t & i_featureId, const bool & i_sendAsAlarm, const uint64_t & i_timestamp
This API wrapper function is used by agents to log an event with a timestamp.
Parameters:
|
in |
i_eventId |
event id |
|
in |
i_eventData |
data string to be added |
|
in |
i_eventDataLength |
length of the data string |
|
in |
i_featureId |
feature if |
|
in |
i_sendAsAlarm |
send the event as alarm or not? |
|
in |
i_timestamp |
current time stamp to be logged |
Returns:
Returns the API success or failure accordingly.
AgentApiReturnType common::apiUpstreamForAgentData (const uint32_t & i_featureId, const char * i_data, const uint32_t & i_length)
This API wrapper function is used to write contents into agentdata.
Parameters:
|
in |
i_featureId |
feature id |
|
in |
i_data |
Data string to be added |
|
in |
i_length |
length of the data string |
Returns:
Returns the API success or failure accordingly.
AgentApiReturnType common::apiWriteAgentDataForUpstreamSystemWithTimestamp (const uint32_t & i_featureId, const char * i_data, const uint32_t & i_length, const uint64_t & i_timestamp)
This API wrapper function is used to write contents into agentdata using timestamp.
Parameters:
|
in |
i_featureId |
feature id |
|
in |
i_data |
data string to be added |
|
in |
i_length |
length of the data string |
|
in |
i_timestamp |
current time stamp to be logged |
Returns:
Returns the API success or failure accordingly.
bool common::CheckAPIErrorStatus (AgentApiReturnType i_APIRetVal)
CheckAPIErrorStatus: This function checks the API return type error status.
Parameters:
|
i_APIRetVal |
return value of an API call |
Returns:
Returns false if API success or failure accordingly.