kaa_extension.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.
 */

#ifndef KAA_EXTENSION_H
#define KAA_EXTENSION_H

#include <kaa_common.h>
#include <kaa_error.h>
#include <stddef.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

// Forward-declaring kaa_context_t
struct kaa_context_s;

struct kaa_extension {
    kaa_extension_id id;

    kaa_error_t (*init)(struct kaa_context_s *kaa_context, void **context);

    kaa_error_t (*deinit)(void *context);

    kaa_error_t (*request_serialize)(void *context, uint32_t request_id,
            uint8_t *buffer, size_t *size, bool *sync_needed);

    kaa_error_t (*server_sync)(void *context, uint32_t request_id,
            uint16_t extension_options, const uint8_t *buffer, size_t size);
};

const struct kaa_extension *kaa_extension_get(kaa_extension_id id);

void *kaa_extension_get_context(kaa_extension_id id);

kaa_error_t kaa_extension_set_context(kaa_extension_id id, void *context);

kaa_error_t kaa_extension_init_all(struct kaa_context_s *kaa_context);

kaa_error_t kaa_extension_deinit_all(void);

kaa_error_t kaa_extension_request_serialize(kaa_extension_id id, uint32_t request_id,
        uint8_t *buffer, size_t *size, bool *sync_needed);

kaa_error_t kaa_extension_server_sync(kaa_extension_id id, uint32_t request_id,
        uint16_t extension_options, const uint8_t *buffer, size_t size);

#ifdef __cplusplus
}
#endif

#endif /* KAA_EXTENSION_H */