Kaa client C SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
kaa_client.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 
17 /*
18  * @file kaa_client.h
19  * @brief Kaa client header for different boards. Initialize Kaa framework and include main loop around IO network
20  * operations.
21  *
22  * Created on: Apr 15, 2015
23  * Author: Andriy Panasenko <apanasenko@cybervisiontech.com>
24  */
25 
26 #ifndef KAA_PLATFORM_KAA_CLIENT_H_
27 #define KAA_PLATFORM_KAA_CLIENT_H_
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #include <platform/time.h>
34 
35 #include "kaa_context.h"
37 
38 struct kaa_client_t;
39 typedef struct kaa_client_t kaa_client_t;
40 
41 typedef void (*external_process_fn)(void *context);
42 
54 
64 void kaa_client_destroy(kaa_client_t *kaa_client);
65 
79  , external_process_fn external_process
80  , void *external_process_context
81  , kaa_time_t max_delay);
82 
93 
102 
103 #ifdef __cplusplus
104 } /* extern "C" */
105 #endif
106 #endif /* KAA_PLATFORM_KAA_CLIENT_H_ */
void kaa_client_destroy(kaa_client_t *kaa_client)
De-initializes and destroys Kaa client.
struct kaa_client_t kaa_client_t
Definition: kaa_client.h:39
General Kaa endpoint context.
Definition: kaa_context.h:50
kaa_error_t
Definition: kaa_error.h:31
Kaa endpoint context definition.
long kaa_time_t
Definition: time.h:23
Definition: kaa_client_properties.h:27
kaa_error_t kaa_client_start(kaa_client_t *kaa_client, external_process_fn external_process, void *external_process_context, kaa_time_t max_delay)
Start Kaa client.
kaa_error_t kaa_client_create(kaa_client_t **kaa_client, kaa_client_props_t *props)
Creates and initializes kaa_client.
kaa_error_t kaa_client_stop(kaa_client_t *kaa_client)
Stop Kaa client.
void(* external_process_fn)(void *context)
Definition: kaa_client.h:41
kaa_context_t * kaa_client_get_context(kaa_client_t *kaa_client)
Return pointer to Kaa context.