Kaa client C SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
kaa.h
Go to the documentation of this file.
1 /*
2  * Copyright 2014-2016 CyberVision, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
24 #ifndef KAA_H_
25 #define KAA_H_
26 
27 #include <stdbool.h>
28 #include "kaa_context.h"
29 #include "kaa_error.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 
36 
46 kaa_error_t kaa_init(kaa_context_t **kaa_context_p);
47 
48 
49 
59 kaa_error_t kaa_start(kaa_context_t *kaa_context);
60 
70 kaa_error_t kaa_stop(kaa_context_t *kaa_context);
71 
72 
83 
84 
85 
93 bool kaa_process_failover(kaa_context_t *kaa_context);
94 
95 
96 
105 
106 #ifdef __cplusplus
107 } /* extern "C" */
108 #endif
109 #endif /* KAA_H_ */
General Kaa endpoint context.
Definition: kaa_context.h:50
kaa_error_t
Definition: kaa_error.h:31
Kaa endpoint context definition.
Kaa error codes.
kaa_error_t kaa_stop(kaa_context_t *kaa_context)
Stops Kaa's workflow.
kaa_error_t kaa_init(kaa_context_t **kaa_context_p)
Creates and initializes general Kaa endpoint context.
kaa_error_t kaa_deinit(kaa_context_t *kaa_context)
De-initializes and destroys general Kaa endpoint context.
kaa_error_t kaa_start(kaa_context_t *kaa_context)
Starts Kaa's workflow.
bool kaa_process_failover(kaa_context_t *kaa_context)
Processes failovers.
kaa_error_t kaa_check_readiness(kaa_context_t *kaa_context)
Checks if Kaa context is initialized and ready to be used.