docker_volumes.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2018-2022 Abhishek Mishra
 *
 * This file is part of clibdocker.
 *
 * clibdocker is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation, 
 * either version 3 of the License, or (at your option) 
 * any later version.
 *
 * clibdocker is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty 
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public 
 * License along with clibdocker. 
 * If not, see <https://www.gnu.org/licenses/>.
 *
 */
 
#ifndef SRC_DOCKER_VOLUMES_H_
#define SRC_DOCKER_VOLUMES_H_
 
#ifdef __cplusplus  
extern "C" {
#endif
 
#include <stdlib.h>
#include "docker_connection_util.h"
#include "docker_util.h"
 
typedef json_object                                     docker_volume;
 
#define free_docker_volume(vol)                         json_object_put((json_object*) vol)
 
#define docker_volume_name_get(vol)                     get_attr_str((json_object*)vol, "Name")
 
#define docker_volume_driver_get(vol)                   get_attr_str((json_object*)vol, "Driver")
 
#define docker_volume_mountpoint_vol_get(vol)           get_attr_str((json_object*)vol, "Mountpoint")
 
#define docker_volume_go_scope_get(vol)                 get_attr_str((json_object*)vol, "Scope")
 
#define docker_volume_creation_time_get(vol)            get_attr_time((json_object*)vol, "CreatedAt")
 
#define docker_volume_labels_get(vol)                   get_attr_json_object((json_object*)vol, "Labels")
 
#define docker_volume_labels_foreach(vol)               json_object_object_foreach(docker_volume_labels_get(vol), key, val)
 
#define docker_volume_options_get(vol)                  get_attr_json_object((json_object*)vol, "Options")
 
#define docker_volume_options_foreach(vol)              json_object_object_foreach(docker_volume_options_get(vol), key, val)
 
typedef json_object                                     docker_volume_list;
 
#define free_docker_volume_list(volume_ls)              json_object_put(volume_ls)
 
#define docker_volume_list_length(volume_ls)            json_object_array_length(volume_ls)
 
#define docker_volume_list_get_idx(volume_ls, i)        (docker_volume*) json_object_array_get_idx(volume_ls, i)
 
typedef json_object                                     docker_volume_warnings;
 
#define free_docker_warnings(warnings)                  json_object_put(warnings)
 
#define docker_warnings_length(warnings)                json_object_array_length(warnings)
 
#define docker_warnings_get_idx(warnings, i)            (char*) json_object_array_get_idx(warnings, i)
 
MODULE_API d_err_t docker_volumes_list(docker_context* ctx, 
        docker_volume_list** volumes, docker_volume_warnings** warnings,
        int filter_dangling, char* filter_driver, char* filter_label,
        char* filter_name);
 
MODULE_API d_err_t docker_volume_create(docker_context* ctx, 
        docker_volume** volume, char* name, char* driver, int num_labels,
        ...);
 
MODULE_API d_err_t docker_volume_inspect(docker_context* ctx, 
        docker_volume** volume, char* name);
 
MODULE_API d_err_t docker_volume_delete(docker_context* ctx, 
        const char* name, int force);
 
MODULE_API d_err_t docker_volumes_delete_unused(docker_context* ctx,
        arraylist** volumes_deleted,
        unsigned long* space_reclaimed, int num_label_filters, ...);
 
#ifdef __cplusplus 
}
#endif
 
#endif