iotcs_virtual_device.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
 *
 * This software is dual-licensed to you under the MIT License (MIT) and
 * the Universal Permissive License (UPL). See the LICENSE file in the root
 * directory for license terms. You may choose either license, or both.
 */

#ifndef IOTCS_DEVICE_VIRTUAL_H
#define IOTCS_DEVICE_VIRTUAL_H

#ifdef __cplusplus
extern "C" {
#endif

#include "iotcs.h"
#include "advanced/iotcs_message.h"

    typedef struct iotcs_virtual_device_handle_t* iotcs_virtual_device_handle;

    typedef struct iotcs_named_value_t {
        const char *name; 
        iotcs_typed_value typed_value; 
        struct iotcs_named_value_t *next; 
    } iotcs_named_value;
    typedef struct iotcs_virtual_device_change_event_t {
        iotcs_named_value named_value; 
        iotcs_virtual_device_handle virtual_device_handle; 
    } iotcs_virtual_device_change_event;
    typedef struct iotcs_virtual_device_error_event_t {
        iotcs_named_value named_value; 
        iotcs_virtual_device_handle virtual_device_handle; 
        const char *message; 
    } iotcs_virtual_device_error_event;
    typedef void (*iotcs_virtual_device_changed_callback)(iotcs_virtual_device_change_event *event);

    typedef void (*iotcs_action_callback)(iotcs_virtual_device_handle virtual_device_handle,
            iotcs_typed_value argument);
 
    typedef void (*iotcs_virtual_device_on_action_callback)(iotcs_virtual_device_handle device_handle, char *action, iotcs_named_value *argument);


    typedef void (*iotcs_virtual_device_error_callback)(iotcs_virtual_device_error_event *event);

    typedef struct iotcs_device_model_handle_t* iotcs_device_model_handle;

    typedef struct iotcs_alert_handle_t* iotcs_alert_handle;

    typedef struct iotcs_data_handle_t* iotcs_data_handle;

    iotcs_result iotcs_get_device_model(const char *device_model, iotcs_device_model_handle *device_model_handle);

    const char * iotcs_get_device_model_name(iotcs_device_model_handle device_model_handle);

    const char * iotcs_get_device_model_description(iotcs_device_model_handle device_model_handle);

    const char * iotcs_get_device_model_urn(iotcs_device_model_handle device_model_handle);

    void iotcs_free_device_model(iotcs_device_model_handle device_model_handle);

    iotcs_result iotcs_create_virtual_device_handle(const char *endpoint_id, iotcs_device_model_handle device_model_handle, iotcs_virtual_device_handle *virtual_device_handle);

    void iotcs_free_virtual_device_handle(iotcs_virtual_device_handle virtual_device_handle);

    iotcs_result iotcs_virtual_device_set(iotcs_virtual_device_handle virtual_device_handle, const char* attribute_name, const void* value, size_t length);

#if defined IOTCS_IMPLICIT_EDGE_COMPUTING || defined IOTCS_DOXYGEN

    iotcs_result iotcs_virtual_device_offer_boolean(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_bool value);

    iotcs_result iotcs_virtual_device_offer_integer(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, int value);

    iotcs_result iotcs_virtual_device_offer_float(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, float value);

    iotcs_result iotcs_virtual_device_offer_date_time(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_date_time value);
#endif

    iotcs_result iotcs_virtual_device_get_string(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, const char **value);

    iotcs_result iotcs_virtual_device_set_string(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, const char *value);

    iotcs_result iotcs_virtual_device_get_integer(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, int *value);

    iotcs_result iotcs_virtual_device_set_integer(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, int value);

    iotcs_result iotcs_virtual_device_get_float(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, float *value);

    iotcs_result iotcs_virtual_device_set_float(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, float value);

    iotcs_result iotcs_virtual_device_get_boolean(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_bool *value);

    iotcs_result iotcs_virtual_device_set_boolean(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_bool value);

    iotcs_result iotcs_virtual_device_get_date_time(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_date_time *value);

    iotcs_result iotcs_virtual_device_set_date_time(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_date_time value);

    void iotcs_virtual_device_set_on_change(iotcs_virtual_device_handle virtual_device_handle, iotcs_virtual_device_changed_callback callback);

    iotcs_result iotcs_virtual_device_attribute_set_on_change(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_virtual_device_changed_callback callback);

    void iotcs_virtual_device_set_on_error(iotcs_virtual_device_handle virtual_device_handle, iotcs_virtual_device_error_callback callback);

    iotcs_result iotcs_virtual_device_attribute_set_on_error(iotcs_virtual_device_handle virtual_device_handle, const char *attribute_name, iotcs_virtual_device_error_callback callback);

    iotcs_result iotcs_virtual_device_set_callback(iotcs_virtual_device_handle virtual_device_handle, const char *action_name, iotcs_action_callback callback);

    iotcs_result iotcs_virtual_device_set_on_action_callback(iotcs_virtual_device_handle virtual_device_handle, const char *action_name, iotcs_virtual_device_on_action_callback callback);
 
    iotcs_result iotcs_virtual_device_set_global_on_action_callback(iotcs_virtual_device_handle virtual_device_handle, iotcs_virtual_device_on_action_callback callback);

    void iotcs_virtual_device_start_update(iotcs_virtual_device_handle virtual_device_handle);

    void iotcs_virtual_device_finish_update(iotcs_virtual_device_handle virtual_device_handle);

    iotcs_result iotcs_virtual_device_create_alert_handle(iotcs_virtual_device_handle virtual_device_handle, const char *alert_name, iotcs_alert_handle *alert_handle);

    void iotcs_virtual_device_free_alert_handle(iotcs_alert_handle alert_handle);

    iotcs_result iotcs_alert_raise(iotcs_alert_handle alert_handle);

    void iotcs_alert_set_on_error(iotcs_alert_handle alert_handle, iotcs_virtual_device_error_callback callback);

    iotcs_result iotcs_alert_set(iotcs_alert_handle alert_handle, const char* field, const void* value, size_t length);

    iotcs_result iotcs_alert_set_string(iotcs_alert_handle alert_handle, const char *field, const char *value);

    iotcs_result iotcs_alert_set_integer(iotcs_alert_handle alert_handle, const char *field, int value);

    iotcs_result iotcs_alert_set_float(iotcs_alert_handle alert_handle, const char *field, float value);

    iotcs_result iotcs_alert_set_boolean(iotcs_alert_handle alert_handle, const char *field, iotcs_bool value);

    iotcs_result iotcs_alert_set_date_time(iotcs_alert_handle alert_handle, const char *field, iotcs_date_time value);

    iotcs_result iotcs_alert_set_storage_object(iotcs_alert_handle alert_handle, const char *field,
            iotcs_storage_object_handle value);

#if !defined IOTCS_DOXYGEN

    iotcs_result iotcs_alert_set_external_object(iotcs_alert_handle alert_handle, const char *field,
            iotcs_external_object_handle value);
#endif

    iotcs_result iotcs_virtual_device_create_data_handle(iotcs_virtual_device_handle virtual_device_handle, const char *data_name, iotcs_data_handle *data_handle);

    iotcs_result iotcs_virtual_device_set_storage_object(iotcs_virtual_device_handle virtual_device_handle,
            const char *attribute_name, iotcs_storage_object_handle value);

#if !defined IOTCS_DOXYGEN

    iotcs_result iotcs_virtual_device_set_external_object(iotcs_virtual_device_handle virtual_device_handle,
            const char *attribute_name, iotcs_external_object_handle value);
#endif

    iotcs_result iotcs_virtual_device_get_storage_object(iotcs_virtual_device_handle virtual_device_handle,
            const char *attribute_name, iotcs_storage_object_handle *value);

#if !defined IOTCS_DOXYGEN

    iotcs_result iotcs_virtual_device_get_external_object(iotcs_virtual_device_handle virtual_device_handle,
            const char *attribute_name, iotcs_external_object_handle *value);
#endif

    void iotcs_virtual_device_free_data_handle(iotcs_data_handle data_handle);

    iotcs_result iotcs_data_submit(iotcs_data_handle data_handle);

    iotcs_result iotcs_data_set(iotcs_data_handle data_handle, const char* field, const void* value, size_t length);

    void iotcs_data_set_on_error(iotcs_data_handle data_handle, iotcs_virtual_device_error_callback callback);

    iotcs_result iotcs_data_set_string(iotcs_data_handle data_handle, const char *field, const char *value);

    iotcs_result iotcs_data_set_integer(iotcs_data_handle data_handle, const char *field, int value);

    iotcs_result iotcs_data_set_float(iotcs_data_handle data_handle, const char *field, float value);

    iotcs_result iotcs_data_set_boolean(iotcs_data_handle data_handle, const char *field, iotcs_bool value);

    iotcs_result iotcs_data_set_date_time(iotcs_data_handle data_handle, const char *field, iotcs_date_time value);

    iotcs_result iotcs_data_set_storage_object(iotcs_data_handle data_handle, const char *field,
            iotcs_storage_object_handle value);

#if !defined IOTCS_DOXYGEN

    iotcs_result iotcs_data_set_external_object(iotcs_data_handle data_handle, const char *field,
            iotcs_external_object_handle value);
#endif
#ifdef __cplusplus
}
#endif

#endif /* IOTCS_DEVICE_VIRTUAL_H */