iotcs_storage_object.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 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_VIRTUAL_STORAGE_OBJECT_H_
#define IOTCS_VIRTUAL_STORAGE_OBJECT_H_

#include <stdint.h>

#include "iotcs.h"
#include "advanced/iotcs_messaging.h"
#include "iotcs_virtual_device.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef enum iotcs_storage_object_sync_status_t{
        IOTCS_IN_SYNC = 0, 
        IOTCS_NOT_IN_SYNC = 1, 
        IOTCS_SYNC_FAILED = 2, 
        IOTCS_SYNC_PENDING = 3, 
    } iotcs_storage_object_sync_status;

    typedef struct iotcs_storage_object_sync_event_t {
        const char *name; 
        iotcs_storage_object_handle source; 
        iotcs_virtual_device_handle virtual_device; 
    } iotcs_storage_object_sync_event;
    typedef void(*iotcs_storage_object_sync_callback)(iotcs_storage_object_sync_event *event);

    iotcs_result iotcs_create_storage_object_handle(const char* name, const char* content_type,
        iotcs_storage_object_handle *storage_object_handle);

    iotcs_result iotcs_storage_object_set_custom_metadata(iotcs_storage_object_handle storage_object_handle,
        const char* name, const char* value);
#if !defined IOTCS_DOXYGEN

    iotcs_result iotcs_create_external_object_handle(const char* uri,
            iotcs_external_object_handle *external_object_handle);
#endif

    void iotcs_free_storage_object_handle(iotcs_storage_object_handle storage_object_handle);

#if !defined IOTCS_DOXYGEN

    void iotcs_free_external_object_handle(iotcs_external_object_handle external_object_handle);
#endif

#if !defined IOTCS_STORAGE_OBJECT_H_ || defined IOTCS_DOXYGEN
#if !defined IOTCS_DOXYGEN

    const char* iotcs_external_object_get_uri(const iotcs_external_object_handle external_object_handle);
#endif

    iotcs_result iotcs_storage_object_set_input_path(iotcs_storage_object_handle storage_object_handle, const char *input_path);

    iotcs_result iotcs_storage_object_set_output_path(iotcs_storage_object_handle storage_object_handle, const char *output_path);

    iotcs_result iotcs_storage_object_set_callback(iotcs_storage_object_handle storage_object_handle, iotcs_storage_object_sync_callback callback);

    iotcs_storage_object_sync_status iotcs_storage_object_get_sync_status(const iotcs_storage_object_handle storage_object_handle);

    const char* iotcs_storage_object_get_input_path(const iotcs_storage_object_handle storage_object_handle);

    const char* iotcs_storage_object_get_output_path(const iotcs_storage_object_handle storage_object_handle);

    const char* iotcs_storage_object_get_name(const iotcs_storage_object_handle storage_object_handle);

    const char* iotcs_storage_object_get_uri(const iotcs_storage_object_handle storage_object_handle);

    long iotcs_storage_object_get_length(const iotcs_storage_object_handle storage_object_handle);

    const char* iotcs_storage_object_get_type(const iotcs_storage_object_handle storage_object_handle);

    const char* iotcs_storage_object_get_encoding(const iotcs_storage_object_handle storage_object_handle);

    iotcs_date_time iotcs_storage_object_get_date(const iotcs_storage_object_handle storage_object_handle);

    iotcs_result iotcs_storage_object_sync(iotcs_storage_object_handle storage_object_handle);
#endif

#ifdef __cplusplus
}
#endif

#endif /* IOTCS_VIRTUAL_STORAGE_OBJECT_H_ */