globus_dsi_rest.h

Go to the documentation of this file.

/*
 * Copyright 1999-2016 University of Chicago
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


 
#ifndef GLOBUS_DSI_REST_H
#define GLOBUS_DSI_REST_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdbool.h>
#include "globus_common.h"
#include "globus_gridftp_server.h"


typedef 
struct globus_dsi_rest_key_value_s
{
    const char                     *key;
    const char                     *value;
}
globus_dsi_rest_key_value_t;

typedef
struct globus_dsi_rest_key_array_s
{
    size_t                              count;
    globus_dsi_rest_key_value_t        *key_value;
}
globus_dsi_rest_key_array_t;

typedef
globus_result_t (*globus_dsi_rest_response_t) (
    void                               *response_callback_arg,
    int                                 response_code,
    const char                         *response_status,
    const globus_dsi_rest_key_array_t  *response_headers);

typedef
globus_result_t (*globus_dsi_rest_write_t) (
    void                               *write_callback_arg,
    void                               *buffer,
    size_t                              buffer_length,
    size_t                             *amount_copied);

typedef
globus_result_t
(*globus_dsi_rest_read_t) (
    void                               *read_callback_arg,
    void                               *buffer,
    size_t                              buffer_length);

typedef
void
(*globus_dsi_rest_complete_t) (
    void                               *complete_callback_arg,
    globus_result_t                     result);

typedef
globus_result_t
(*globus_dsi_rest_progress_t) (
    void                               *progress_callback_arg,
    uint64_t                            total_read,
    uint64_t                            amt_read,
    uint64_t                            total_written,
    uint64_t                            amt_written);
 
typedef
struct globus_dsi_rest_callbacks_s
{
    globus_dsi_rest_response_t          response_callback;
    void                               *response_callback_arg;

    globus_dsi_rest_complete_t          complete_callback;
    void                               *complete_callback_arg;

    globus_dsi_rest_write_t             data_write_callback;
    void                               *data_write_callback_arg;

    globus_dsi_rest_read_t              data_read_callback;
    void                               *data_read_callback_arg;

    globus_dsi_rest_progress_t          progress_callback;
    void                               *progress_callback_arg;
}
globus_dsi_rest_callbacks_t;

globus_result_t
globus_dsi_rest_request(
    const char                         *method,
    const char                         *uri,
    const globus_dsi_rest_key_array_t  *query_parameters,
    const globus_dsi_rest_key_array_t  *headers,
    const globus_dsi_rest_callbacks_t  *callbacks);
 
globus_result_t
globus_dsi_rest_request_peek(
    const char                         *method,
    const char                         *uri,
    const globus_dsi_rest_key_array_t  *query_parameters,
    const globus_dsi_rest_key_array_t  *headers,
    const globus_dsi_rest_callbacks_t  *callbacks,
    globus_dsi_rest_read_t              data_peek_callback,
    void                               *data_peek_callback_arg);

globus_result_t
globus_dsi_rest_uri_add_query(
    const char                         *uri,
    const globus_dsi_rest_key_array_t  *query_parameters,
    char                              **complete_urip);

globus_result_t
globus_dsi_rest_uri_escape(
    const char                         *s,
    char                              **escaped);
 
bool
globus_dsi_rest_error_is_retryable(
    globus_result_t                     result);

typedef
struct globus_dsi_rest_write_block_arg_s
{
    void                               *block_data;
    size_t                              block_len;
}
globus_dsi_rest_write_block_arg_t;

extern globus_dsi_rest_write_t const    globus_dsi_rest_write_block;

extern globus_dsi_rest_write_t const    globus_dsi_rest_write_json;

typedef struct
{
    globus_dsi_rest_write_block_arg_t  *blocks;
    size_t                              block_count;
}
globus_dsi_rest_write_blocks_arg_t;
extern globus_dsi_rest_write_t const    globus_dsi_rest_write_blocks;

extern globus_dsi_rest_write_t const    globus_dsi_rest_write_form;

typedef
struct globus_dsi_rest_gridftp_op_arg_s
{
    globus_gfs_operation_t              op;
    globus_off_t                        offset;
    globus_off_t                        length;
    bool                                eof;
}
globus_dsi_rest_gridftp_op_arg_t;

extern globus_dsi_rest_write_t const    globus_dsi_rest_write_gridftp_op;

typedef
struct globus_dsi_rest_write_multipart_arg_s
{
    size_t                              num_parts;
 
    struct globus_dsi_rest_write_part_s
    {
        globus_dsi_rest_write_t         data_write_callback;
        void                           *data_write_callback_arg;
        globus_dsi_rest_key_array_t     part_header;
    } *parts;
}
globus_dsi_rest_write_multipart_arg_t;

extern globus_dsi_rest_write_t const    globus_dsi_rest_write_multipart;

typedef
struct globus_dsi_rest_read_multipart_arg_s
{
    size_t                              num_parts;
 
    struct globus_dsi_rest_read_part_s
    {
        globus_dsi_rest_response_t      response_callback;
        void                           *response_callback_arg;
        globus_dsi_rest_read_t          data_read_callback;
        void                           *data_read_callback_arg;
    } *parts;
}
globus_dsi_rest_read_multipart_arg_t;

extern globus_dsi_rest_read_t const     globus_dsi_rest_read_multipart;

extern globus_dsi_rest_read_t const     globus_dsi_rest_read_json;

extern globus_dsi_rest_read_t const     globus_dsi_rest_read_gridftp_op;

extern globus_dsi_rest_progress_t const globus_dsi_rest_progress_idle_timeout;
 

typedef
struct globus_dsi_rest_response_arg_s
{
    int                                 response_code;
    globus_dsi_rest_key_array_t         desired_headers;
    off_t                               request_bytes_uploaded;
    off_t                               response_bytes_downloaded;
}
globus_dsi_rest_response_arg_t;

extern globus_dsi_rest_response_t const globus_dsi_rest_response;
 
extern globus_module_descriptor_t       globus_i_dsi_rest_module;
 
enum
{
    GLOBUS_DSI_REST_ERROR_PARAMETER = 1,
    GLOBUS_DSI_REST_ERROR_MEMORY,
    GLOBUS_DSI_REST_ERROR_PARSE,
    GLOBUS_DSI_REST_ERROR_CURL,
    GLOBUS_DSI_REST_ERROR_JSON,
    GLOBUS_DSI_REST_ERROR_TIME_OUT,
    GLOBUS_DSI_REST_ERROR_THREAD_FAIL,
    GLOBUS_DSI_REST_ERROR_UNEXPECTED_DATA,
};
 
#define GLOBUS_DSI_REST_MODULE (&globus_i_dsi_rest_module)
 
#ifdef __cplusplus
}
#endif
 
#endif /* GLOBUS_DSI_REST_H */