docker_result.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_RESULT_H_
#define SRC_DOCKER_RESULT_H_
 
#ifdef __cplusplus  
extern "C" {
#endif
 
#include "docker_common.h"
#include <time.h>
 
#define DOCKER_PARAM_TRUE 1
 
#define DOCKER_PARAM_FALSE 0
 
// The error code usage below based on suggestions at
// https://stackoverflow.com/questions/6286874/c-naming-suggestion-for-error-code-enums
 
enum _config_error {
    E_UNKNOWN_ERROR = 1,
    E_SUCCESS = 0,
    E_INVALID_INPUT = -1,
    E_FILE_NOT_FOUND = -2,
    E_ALLOC_FAILED = -3,
    E_PING_FAILED = -4,
    E_CONNECTION_FAILED = -5
};
 
typedef enum _config_error d_err_t;
 
#define HTTP_GET_STR "GET"
 
#define HTTP_POST_STR "POST"
 
#define HTTP_DELETE_STR "DELETE"
 
/* use this to provide a perror style method to help consumers out */
//struct _errordesc {
//  int code;
//  char *message;
//} errordesc[] = { { E_SUCCESS, "No error" },
//      { E_INVALID_INPUT, "Invalid input" }, { E_FILE_NOT_FOUND,
//              "File not found" }, };
 
typedef struct docker_result_t {
    d_err_t error_code;         
    time_t start_time;          
    time_t end_time;            
    char* url;                  
    char* method;               
    char* request_json_str;     
    char* response_json_str;    
    long http_error_code;       
    char* message;              
} docker_result;
 
MODULE_API d_err_t new_docker_result(docker_result** result);
 
//MODULE_API d_err_t make_docker_result(docker_result** result, d_err_t error_code,
//      long http_error_code, const char* url, const char* msg);
 
MODULE_API void free_docker_result(docker_result* result);
 
MODULE_API docker_result* docker_result_clone(docker_result* result);
 
MODULE_API d_err_t docker_result_get_error_code(docker_result* result);
 
MODULE_API time_t docker_result_get_start_time(docker_result* result);
 
MODULE_API time_t docker_result_get_end_time(docker_result* result);
 
MODULE_API char* docker_result_get_url(docker_result* result);
 
MODULE_API char* docker_result_get_method(docker_result* result);
 
MODULE_API char* docker_result_get_request_json_str(docker_result* result);
 
MODULE_API char* docker_result_get_response_json_str(docker_result* result);
 
MODULE_API long docker_result_get_http_error_code(docker_result* result);
 
MODULE_API char* docker_result_get_message(docker_result* result);
 
MODULE_API int is_ok(docker_result* result);
 
 
//TODO these two functions can be made a single generic function.
MODULE_API void docker_simple_error_handler_print(docker_result* res);
 
MODULE_API void docker_simple_error_handler_log(docker_result* res);
 
#ifdef __cplusplus 
}
#endif
 
#endif /* SRC_DOCKER_RESULT_H_ */