mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-27 08:49:16 +08:00
49737888ca
## Improvements to S3 Documentation * Create a new document *quickstart_paths.md* that give a summary of the legal path formats used by netcdf-c. This includes both file paths and URL paths. * Modify *nczarr.md* to remove most of the S3 related text. * Move the S3 text from *nczarr.md* to a new document *cloud.md*. * Add some S3-related text to the *byterange.md* document. Hopefully, this will make it easier for users to find the information they want. ## Rebuild NCZarr Testing In order to avoid problems with running make check in parallel, two changes were made: 1. The *nczarr_test* test system was rebuilt. Now, for each test. any generated files are kept in a test-specific directory, isolated from all other test executions. 2. Similarly, since the S3 test bucket is shared, any generated S3 objects are isolated using a test-specific key path. ## Other S3 Related Changes * Add code to ensure that files created on S3 are reclaimed at end of testing. * Used the bash "trap" command to ensure S3 cleanup even if the test fails. * Cleanup the S3 related configure.ac flag set since S3 is used in several places. So now one should use the option *--enable-s3* instead of *--enable-nczarr-s3*, although the latter is still kept as a deprecated alias for the former. * Get some of the github actions yml to work with S3; required fixing various test scripts adding a secret to access the Unidata S3 bucket. * Cleanup S3 portion of libnetcdf.settings.in and netcdf_meta.h.in and test_common.in. * Merge partial S3 support into dhttp.c. * Create an experimental s3 access library especially for use with Windows. It is enabled by using the options *--enable-s3-internal* (automake) or *-DENABLE_S3_INTERNAL=ON* (CMake). Also add a unit-test for it. * Move some definitions from ncrc.h to ncs3sdk.h ## Other Changes * Provide a default implementation of strlcpy and move this and similar defaults into *dmissing.c*.
63 lines
1.9 KiB
C
63 lines
1.9 KiB
C
/* Copyright 2018-2018 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
/**
|
|
* Header file for dhttp.c
|
|
* @author Dennis Heimbigner
|
|
*/
|
|
|
|
#ifndef NCHTTP_H
|
|
#define NCHTTP_H
|
|
|
|
typedef enum HTTPMETHOD {
|
|
HTTPNONE=0, HTTPGET=1, HTTPPUT=2, HTTPPOST=3, HTTPHEAD=4, HTTPDELETE=5
|
|
} HTTPMETHOD;
|
|
|
|
/* Forward */
|
|
struct CURL;
|
|
struct NCS3INFO;
|
|
struct NCURI;
|
|
|
|
/* Common state For S3 vs Simple Curl */
|
|
typedef enum NC_HTTPFORMAT {HTTPS3=1, HTTPCURL=2} NC_HTTPFORMAT;
|
|
|
|
typedef struct NC_HTTP_STATE {
|
|
enum NC_HTTPFORMAT format; /* Discriminator */
|
|
char* path; /* original url */
|
|
struct NCURI* url; /* parsed url */
|
|
long httpcode;
|
|
char* errmsg; /* do not free if format is HTTPCURL */
|
|
#ifdef ENABLE_S3
|
|
struct NC_HTTP_S3 {
|
|
void* s3client;
|
|
struct NCS3INFO* info;
|
|
} s3;
|
|
#endif
|
|
struct NC_HTTP_CURL {
|
|
struct CURL* curl;
|
|
char errbuf[2048]; /* assert(CURL_ERROR_SIZE <= 2048) */
|
|
struct Response {
|
|
NClist* headset; /* which headers to capture */
|
|
NClist* headers; /* Set of captured headers */
|
|
NCbytes* buf; /* response content; call owns; do not free */
|
|
} response;
|
|
struct Request {
|
|
HTTPMETHOD method;
|
|
size_t payloadsize;
|
|
void* payload; /* caller owns; do not free */
|
|
size_t payloadpos;
|
|
NClist* headers;
|
|
} request;
|
|
} curl;
|
|
} NC_HTTP_STATE;
|
|
|
|
/* External API */
|
|
extern int nc_http_open(const char* url, NC_HTTP_STATE** statep);
|
|
extern int nc_http_open_verbose(const char* url, int verbose, NC_HTTP_STATE** statep);
|
|
extern int nc_http_size(NC_HTTP_STATE* state, long long* sizep);
|
|
extern int nc_http_read(NC_HTTP_STATE* state, size64_t start, size64_t count, NCbytes* buf);
|
|
extern int nc_http_write(NC_HTTP_STATE* state, NCbytes* payload);
|
|
extern int nc_http_close(NC_HTTP_STATE* state);
|
|
extern int nc_http_reset(NC_HTTP_STATE* state);
|
|
|
|
#endif /*NCHTTP_H*/
|