baidu_ca_conf.h

00001 // Copyright 2017 Baidu Inc. All Rights Reserved.
00002 // Author: Su Hao (suhao@baidu.com)
00003 //
00004 // Description: Baidu CA configuration.
00005 
00006 #ifndef BAIDU_IOT_TINYDU_IOT_OS_SRC_IOT_BAIDU_CA_SOURCE_BAIDU_CA_CONF_H
00007 #define BAIDU_IOT_TINYDU_IOT_OS_SRC_IOT_BAIDU_CA_SOURCE_BAIDU_CA_CONF_H
00008 
00009 #include "baidu_ca_types.h"
00010 
00011 typedef void* bca_conf_handler;
00012 
00013 /*
00014  * Create the configuation from buffer
00015  *
00016  * @Param data, in, the configuation stream
00017  * @Param size, in, the data size
00018  * @Return bca_conf_handler, the handler for operating the configuation
00019  */
00020 BCA_INT bca_conf_handler bca_conf_create(const void* data, bca_size_t size);
00021 
00022 /*
00023  * Get the string from the configuration by the key
00024  *
00025  * @Param hdlr, in, the handler for configuation
00026  * @Param key, in, the key of the item
00027  * @Return const char *, the string value of the key
00028  */
00029 BCA_INT const char* bca_conf_get_string(bca_conf_handler hdlr, const char* key);
00030 
00031 /*
00032  * Get the unsigned short from the configuration by the key
00033  *
00034  * @Param hdlr, in, the handler for configuation
00035  * @Param key, in, the key of the item
00036  * @Return bca_u16_t, the unsigned short value of the key
00037  */
00038 BCA_INT bca_u16_t bca_conf_get_ushort(bca_conf_handler hdlr, const char* key);
00039 
00040 /*
00041  * Get the unsigned int from the configuration by the key
00042  *
00043  * @Param hdlr, in, the handler for configuation
00044  * @Param key, in, the key of the item
00045  * @Return bca_u32_t, the unsigned int value of the key
00046  */
00047 BCA_INT bca_u32_t bca_conf_get_uint(bca_conf_handler hdlr, const char* key);
00048 
00049 /*
00050  * Get the string from the configuration by the key
00051  *
00052  * @Param hdlr, in, the handler for configuation
00053  */
00054 BCA_INT void bca_conf_destroy(bca_conf_handler hdlr);
00055 
00056 #endif // BAIDU_IOT_TINYDU_IOT_OS_SRC_IOT_BAIDU_CA_SOURCE_BAIDU_CA_CONF_H