kaa_client.h

Go to the documentation of this file.

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * @file kaa_client.h
 * @brief Kaa client header for different boards. Initialize Kaa framework and include main loop around IO network
 * operations.
 *
 * Created on: Apr 15, 2015
 *    Author: Andriy Panasenko <apanasenko@cybervisiontech.com>
 */

#ifndef KAA_PLATFORM_KAA_CLIENT_H_
#define KAA_PLATFORM_KAA_CLIENT_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <platform/time.h>

#include "kaa_context.h"
#include <platform/kaa_client_properties.h>

struct kaa_client_t;
typedef struct kaa_client_t kaa_client_t;

typedef void (*external_process_fn)(void *context);

kaa_error_t kaa_client_create(kaa_client_t **kaa_client, kaa_client_props_t *props);

void kaa_client_destroy(kaa_client_t *kaa_client);

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);

kaa_error_t kaa_client_stop(kaa_client_t *kaa_client);

kaa_context_t* kaa_client_get_context(kaa_client_t *kaa_client);

#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* KAA_PLATFORM_KAA_CLIENT_H_ */