mcl_communication.h
Go to the documentation of this file.
1 /*!**********************************************************************
2  *
3  * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4  * All rights reserved.
5  *
6  *************************************************************************
7  *
8  * @file mcl_communication.h
9  * @date Sep 8, 2016
10  * @brief Communication module interface header file.
11  *
12  * This module implements MCL communication interface.
13  *
14  ************************************************************************/
15 
16 #ifndef MCL_COMMUNICATION_H_
17 #define MCL_COMMUNICATION_H_
18 
19 #include "mcl/mcl_store.h"
20 #include "mcl/mcl_configuration.h"
21 #include "mcl/mcl_list.h"
22 
23 #ifdef __cplusplus
24 extern "C"
25 {
26 #endif
27 
31  typedef struct mcl_communication_t mcl_communication_t;
32 
60  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_initialize(mcl_configuration_t *configuration, mcl_communication_t **communication);
61 
72  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_destroy(mcl_communication_t **communication);
73 
98  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_onboard(mcl_communication_t *communication);
99 
126  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_rotate_key(mcl_communication_t *communication);
127 
139  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_update_security_information(mcl_communication_t *communication);
140 
171  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_get_access_token(mcl_communication_t *communication);
172 
205  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_exchange(mcl_communication_t *communication, mcl_store_t *store, void **reserved);
206 
236  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_process(mcl_communication_t *communication, mcl_store_t *store, void **reserved);
237 
244  extern MCL_EXPORT mcl_bool_t mcl_communication_is_initialized(mcl_communication_t *communication);
245 
252  extern MCL_EXPORT mcl_bool_t mcl_communication_is_onboarded(mcl_communication_t *communication);
253 
267  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_get_last_access_token(mcl_communication_t *communication, char **token);
268 
282  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_get_last_token_time(mcl_communication_t *communication, char **token_time);
283 
284 #ifdef __cplusplus
285 }
286 #endif
287 
288 #endif //MCL_COMMUNICATION_H_
mcl_configuration_t
Definition: mcl_configuration.h:32
mcl_communication_onboard
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_onboard(mcl_communication_t *communication)
Definition: communication.c:279
mcl_communication_rotate_key
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_rotate_key(mcl_communication_t *communication)
Definition: communication.c:341
MCL_EXPORT
#define MCL_EXPORT
Definition: mcl_config_setup.h:43
mcl_communication_get_last_access_token
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_get_last_access_token(mcl_communication_t *communication, char **token)
Returns the lastly received oauth access token, NULL if server time is not received.
Definition: communication.c:626
mcl_communication_update_security_information
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_update_security_information(mcl_communication_t *communication)
Definition: communication.c:402
mcl_configuration.h
Configuration module interface header file.
mcl_communication_is_initialized
MCL_EXPORT mcl_bool_t mcl_communication_is_initialized(mcl_communication_t *communication)
Can be used to determine if communication handle is initialized.
Definition: communication.c:598
E_MCL_ERROR_CODE
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
mcl_communication_destroy
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_destroy(mcl_communication_t **communication)
Definition: communication.c:241
mcl_communication_exchange
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_exchange(mcl_communication_t *communication, mcl_store_t *store, void **reserved)
Definition: communication.c:473
mcl_store_t
struct mcl_store_t mcl_store_t
Definition: mcl_store.h:34
mcl_list.h
List module interface file.
mcl_communication_initialize
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_initialize(mcl_configuration_t *configuration, mcl_communication_t **communication)
Definition: communication.c:26
mcl_communication_is_onboarded
MCL_EXPORT mcl_bool_t mcl_communication_is_onboarded(mcl_communication_t *communication)
Can be used to determine if communication handle is onboarded.
Definition: communication.c:612
mcl_communication_process
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_process(mcl_communication_t *communication, mcl_store_t *store, void **reserved)
Definition: communication.c:504
mcl_bool_t
mcl_uint8_t mcl_bool_t
Definition: mcl_common.h:47
mcl_store.h
Store module interface header file.
mcl_communication_get_access_token
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_get_access_token(mcl_communication_t *communication)
Definition: communication.c:456
mcl_communication_t
struct mcl_communication_t mcl_communication_t
Definition: mcl_communication.h:31
mcl_communication_get_last_token_time
MCL_EXPORT E_MCL_ERROR_CODE mcl_communication_get_last_token_time(mcl_communication_t *communication, char **token_time)
Returns the time when lastly received oauth access token is received.
Definition: communication.c:648