mcl_connectivity_configuration.h

Go to the documentation of this file.

#ifndef MCL_CONNECTIVITY_CONFIGURATION_H_
#define MCL_CONNECTIVITY_CONFIGURATION_H_

#include "mcl_connectivity/mcl_connectivity_common.h"

#ifdef  __cplusplus
extern "C"
{
#endif

#define MCL_CONNECTIVITY_MAX_HTTP_PAYLOAD_SIZE (10485760)

#define MCL_CONNECTIVITY_DEFAULT_MAX_HTTP_PAYLOAD_SIZE (16384)

#define MCL_CONNECTIVITY_MIN_HTTP_PAYLOAD_SIZE (400)

typedef struct mcl_connectivity_configuration_t mcl_connectivity_configuration_t;

typedef enum E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER
{   
    MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_CORE = 0,              
    MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_MAX_HTTP_PAYLOAD_SIZE, 
    MCL_CONNECTIVITY_CONFIGURATION_PARAMETER_END
} E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER;

/*
 * This function creates and initializes a data struct of #mcl_connectivity_configuration_t.
 *
 * @param [out] configuration Data structure holding the connectivity configuration parameters.
 * @return
 * <ul>
 * <li>#MCL_OK in case of success.</li>
 * <li>#MCL_TRIGGERED_WITH_NULL if provided @p configuration is NULL.</li>
 * <li>#MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.</li>
 * </ul>
 */
extern MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_connectivity_configuration_initialize(mcl_connectivity_configuration_t **configuration);

extern MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_connectivity_configuration_set_parameter(mcl_connectivity_configuration_t *configuration, E_MCL_CONNECTIVITY_CONFIGURATION_PARAMETER parameter, const void *value);

extern MCL_CONNECTIVITY_EXPORT void mcl_connectivity_configuration_destroy(mcl_connectivity_configuration_t **configuration);

#ifdef  __cplusplus
}
#endif

#endif //MCL_CONNECTIVITY_CONFIGURATION_H_