XDK API  3.6.0
Documentation
Data Structures | Typedefs | Functions
AppTxtParser.h File Reference

Interface header for AppTxtParser.h. More...

#include "BCDS_Retcode.h"
+ Include dependency graph for AppTxtParser.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  AppTxtParser_Init_S
 Structure for init credentials for AppTxtParser. More...
 

Typedefs

typedef struct AppTxtParser_Init_S AppTxtParser_Init_T
 Typedef for init credentials for AppTxtParser. More...
 

Functions

const char * AppTxtParser_DTLSPSKIdentityValue (void)
 returns the DTLS/PSK identity of the configuration file More...
 
uint32_t AppTxtParser_DTLSPSKSecretKeyLengthValue (void)
 returns the DTLS/PSK secret key length of the configuration file More...
 
const char * AppTxtParser_DTLSPSKSecretKeyValue (void)
 returns the DTLS/PSK secret key of the configuration file More...
 
Retcode_T AppTxtParser_Initialize (AppTxtParser_Init_T *initCredentials)
 Parse the config file read inside the buffer. More...
 
const char * AppTxtParser_LWM2MBindingValue (void)
 returns lwm2m binding value More...
 
bool AppTxtParser_LWM2MConNotifiesValue (void)
 returns the Lwm2m connection notify value More...
 
const char * AppTxtParser_LWM2MEndPointValue (void)
 returns attribute value for the token LWM2MENDPOINT as defined at the configuration file More...
 
bool AppTxtParser_LWM2MIsSecureValue (void)
 This function checks whether the lwm2m is secure or not based on the url. More...
 
uint32_t AppTxtParser_LWM2MLifetimeValue (void)
 returns lwm2m lifetime in seconds. More...
 
const char * AppTxtParser_LWM2MMACAddrValue (void)
 returns MAC address value for Lwm2m More...
 
uint32_t AppTxtParser_LWM2MServerPortValue (void)
 returns the port value extracted from the server url More...
 
const char * AppTxtParser_LWM2MServerURLValue (void)
 returns attribute value for the token LWM2MDERSRV as defined at the configuration file More...
 
uint8_t AppTxtParser_LWM2MTestModeValue (void)
 Returns the current configuration for the field TESTMODE set in the *.txt file. More...
 
void AppTxtParser_PrintConfigurations (const char *title, bool defaultsOnly)
 Print list of configured values. More...
 
uint32_t AppTxtParser_WLANDnsAddrValue (void)
 returns attribute value for the token DNSSERVER as defined at the configuration file More...
 
uint32_t AppTxtParser_WLANGwAddrValue (void)
 returns attribute value for the token GATEWAY as defined at the configuration file More...
 
uint32_t AppTxtParser_WLANIpAddrValue (void)
 returns attribute value for the token DNSSERVER as defined at the configuration file More...
 
uint32_t AppTxtParser_WLANMaskValue (void)
 returns attribute value for the token MASK as defined at the configuration file More...
 
const char * AppTxtParser_WLANPasswordValue (void)
 returns attribute value for the token PASSWORD as defined at the configuration file More...
 
const char * AppTxtParser_WLANSsidValue (void)
 returns the attribute value for the token SSID as defined at the configuration file More...
 
bool AppTxtParser_WLANStaticIpValue (void)
 returns attribute value for the token STATICIP as defined at the configuration file More...
 

Typedef Documentation

Function Documentation

const char* AppTxtParser_DTLSPSKIdentityValue ( void  )

Refer interface header for description

+ Here is the caller graph for this function:

uint32_t AppTxtParser_DTLSPSKSecretKeyLengthValue ( void  )

Refer interface header for description

+ Here is the caller graph for this function:

const char* AppTxtParser_DTLSPSKSecretKeyValue ( void  )

Refer interface header for description

+ Here is the caller graph for this function:

Retcode_T AppTxtParser_Initialize ( AppTxtParser_Init_T initCredentials)
Parameters
[in]initCredentialscredentials for parsing
Returns
true if configuration file is correct and contains necessary attribute/values

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const char* AppTxtParser_LWM2MBindingValue ( void  )

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool AppTxtParser_LWM2MConNotifiesValue ( void  )

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const char* AppTxtParser_LWM2MEndPointValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the caller graph for this function:

bool AppTxtParser_LWM2MIsSecureValue ( void  )
Returns
true if it is secure, false if not secure

Refer interface header for description

+ Here is the caller graph for this function:

uint32_t AppTxtParser_LWM2MLifetimeValue ( void  )

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const char* AppTxtParser_LWM2MMACAddrValue ( void  )

Refer interface header for description

uint32_t AppTxtParser_LWM2MServerPortValue ( void  )

Refer interface header for description

+ Here is the caller graph for this function:

const char* AppTxtParser_LWM2MServerURLValue ( void  )

Refer interface header for description

+ Here is the caller graph for this function:

uint8_t AppTxtParser_LWM2MTestModeValue ( void  )
Return values
TESTMODE_OFF- If attribute token 'TESTMODE = NO',is defined in config file
TESTMODE_ON- If attribute token 'TESTMODE = YES', is defined in config file
TESTMODE_MIX- If attribute token 'TESTMODE = MIX', is defined in config file
Note
If no entry for TESTMODE configuration in SD card, then the default return value is TESTMODE_MIX

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void AppTxtParser_PrintConfigurations ( const char *  title,
bool  defaultsOnly 
)
Parameters
[in]titletitle for list
[in]defaultsOnlylist only default values

Refer interface header for description

+ Here is the caller graph for this function:

uint32_t AppTxtParser_WLANDnsAddrValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t AppTxtParser_WLANGwAddrValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t AppTxtParser_WLANIpAddrValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t AppTxtParser_WLANMaskValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const char* AppTxtParser_WLANPasswordValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const char* AppTxtParser_WLANSsidValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool AppTxtParser_WLANStaticIpValue ( void  )
Note
If attribute is not defined in configuration file it returns empty string

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:39 by doxygen 1.8.8