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_STORAGE_OBJECT_H_
#define IOTCS_STORAGE_OBJECT_H_

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

#ifdef __cplusplus
extern "C" {
#endif

    typedef enum iotcs_storage_dispatcher_progress_state_t {
        IOTCS_CANCELED = 0, 
        IOTCS_COMPLETED = 1, 
        IOTCS_FAILED = 2, 
        IOTCS_IN_PROGRESS = 3, 
        IOTCS_INITIATED = 4, 
        IOTCS_QUEUED = 5, 
    } iotcs_storage_dispatcher_progress_state;

    typedef void(*iotcs_storage_dispatcher_progress_callback)(iotcs_storage_object *storage_object,
            iotcs_storage_dispatcher_progress_state state,
            int64_t bytes_transfered, const char *fail_reason);

    iotcs_result iotcs_create_storage_object(const char* name, const char* content_type,
            iotcs_storage_object **storage_object);

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

    iotcs_result iotcs_create_external_object(const char* uri,
            iotcs_external_object **external_object);
#endif

    iotcs_result iotcs_create_storage_object_by_uri(const char* uri, iotcs_storage_object **storage_object);

    void iotcs_free_storage_object(iotcs_storage_object *storage_object);

#if !defined IOTCS_DOXYGEN

    void iotcs_free_external_object(iotcs_external_object *external_object);
#endif

    void iotcs_storage_object_cancel(iotcs_storage_object *storage_object);

#if !defined IOTCS_VIRTUAL_STORAGE_OBJECT_H_ || defined IOTCS_DOXYGEN

#if !defined IOTCS_DOXYGEN

    const char* iotcs_external_object_get_uri(const iotcs_external_object *external_object);
#endif

    iotcs_result iotcs_storage_object_set_input_path(iotcs_storage_object *storage_object, const char *input_path);

    iotcs_result iotcs_storage_object_set_output_path(iotcs_storage_object *storage_object, const char *output_path);

    const char* iotcs_storage_object_get_input_path(const iotcs_storage_object *storage_object);

    const char* iotcs_storage_object_get_output_path(const iotcs_storage_object *storage_object);

    const char* iotcs_storage_object_get_name(const iotcs_storage_object *storage_object);

    const char* iotcs_storage_object_get_uri(const iotcs_storage_object *storage_object);

    iotcs_result iotcs_storage_object_sync(iotcs_storage_object* storage_object);

    long iotcs_storage_object_get_length(const iotcs_storage_object* storage_object);

    const char*  iotcs_storage_object_get_type(const iotcs_storage_object* storage_object);

    const char* iotcs_storage_object_get_encoding(const iotcs_storage_object* storage_object);

    iotcs_date_time iotcs_storage_object_get_date(const iotcs_storage_object* storage_object);
#endif

    iotcs_result iotcs_storage_dispatcher_queue(iotcs_storage_object* storage_object);

    void iotcs_storage_dispatcher_set_callback(iotcs_storage_dispatcher_progress_callback callback);
#ifdef __cplusplus
}
#endif

#endif /* IOTCS_STORAGE_OBJECT_H_ */