ikm_io.h

Go to the documentation of this file.

#ifndef IKM_IO_H
#define IKM_IO_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <stdint.h>

#include "ikm_retval.h"
#include "iqr_api.h"

// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data type.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct ikm_IO_struct ikm_IO;

// ---------------------------------------------------------------------------------------------------------------------------------
// Data structure.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct {
    ikm_retval (*initialize)(const void *user_ctx, void **io_ctx);

    ikm_retval (*cleanup)(void **io_ctx);

    ikm_retval (*get_size)(void *io_ctx, uint32_t obj_id, size_t *size);

    ikm_retval (*read)(void *io_ctx, uint32_t obj_id, uint8_t *data, size_t data_size);

    ikm_retval (*write)(void *io_ctx, uint32_t obj_id, const uint8_t *data, size_t data_size);

    ikm_retval (*remove)(void *io_ctx, uint32_t obj_id);
} ikm_IOCallbacks;

// ---------------------------------------------------------------------------------------------------------------------------------
// Input/Output interface object initialization and destruction.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
ikm_retval ikm_IOInterfaceCreate(const ikm_IOCallbacks *cb, void *user_ctx, ikm_IO **io);

IQR_API_UNENFORCED_RETURN
ikm_retval ikm_IOInterfaceDestroy(ikm_IO **io);

// ---------------------------------------------------------------------------------------------------------------------------------
// Simple File Input/Output interface.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
ikm_retval ikm_IOCreateSimpleFileIO(const char *path, ikm_IO **io);

#ifdef __cplusplus
}
#endif

#endif /* IKM_IO_H */