/usr/include/ncbi-vdb/kns/kns-mgr-priv.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kns_mgr_priv_
#define _h_kns_mgr_priv_
#ifndef _h_kns_extern_
#include <kns/extern.h>
#endif
#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif
#ifndef _h_klib_text_
#include <klib/text.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
struct KStream;
struct KHttpFile;
struct KNSManager;
struct KFile;
struct KConfig;
struct KClientHttpRequest;
/************************** HTTP-retry-related stuff **************************/
struct HttpRetrySchedule;
struct HttpRetrySpecs
{
struct HttpRetrySchedule** codes;
uint8_t count;
};
typedef struct HttpRetrySpecs HttpRetrySpecs;
rc_t CC HttpRetrySpecsDestroy ( HttpRetrySpecs* self );
rc_t CC HttpRetrySpecsInit ( HttpRetrySpecs* self, struct KConfig* kfg);
bool HttpGetRetryCodes ( const HttpRetrySpecs* self, uint16_t code, uint8_t * max_retries, const uint16_t ** sleep_before_retry, bool * open_ended );
/* MakeConfig
* create a manager instance using a custom configuration, for testing
*/
KNS_EXTERN rc_t CC KNSManagerMakeConfig ( struct KNSManager **mgr, struct KConfig* kfg );
/** MakeReliableHttpFile, KNSManagerMakeReliableClientRequest:
* Make HTTP file/request from a reliable URL:
* we will try harder to recover upon any error
* (make more retries)
*/
KNS_EXTERN rc_t CC KNSManagerMakeReliableHttpFile(
struct KNSManager const *self, struct KFile const **file,
struct KStream *conn, ver_t vers, const char *url, ...);
KNS_EXTERN rc_t CC KNSManagerMakeReliableClientRequest (
struct KNSManager const *self, struct KClientHttpRequest **req,
ver_t version, struct KStream *conn, const char *url, ... );
typedef struct {
const char *url;
const struct KNSManager * kns; /* used to retrieve HttpRetrySpecs */
uint32_t last_sleep;
uint32_t total_wait_ms;
uint32_t max_total_wait_ms;
uint32_t last_status;
uint8_t max_retries;
uint8_t retries_count;
} KHttpRetrier;
rc_t KHttpRetrierInit ( KHttpRetrier * self, const char * url, const struct KNSManager * kns );
bool KHttpRetrierWait ( KHttpRetrier * self, uint32_t status );
rc_t KHttpRetrierDestroy ( KHttpRetrier * self );
typedef struct HttpProxy HttpProxy;
const HttpProxy * KNSManagerGetHttpProxy ( const struct KNSManager * self );
const HttpProxy * HttpProxyGetNextHttpProxy ( const HttpProxy * self );
/* N.B.: DO NOT WHACK THE RETURNED http_proxy String !!! */
void HttpProxyGet ( const HttpProxy * self,
const String ** http_proxy, uint16_t * http_proxy_port );
/*--------------------------------------------------------------------------
* URLBlock
* RFC 3986
*/
typedef enum
{
st_NONE,
st_HTTP,
st_HTTPS,
st_S3
} SchemeType;
typedef struct URLBlock URLBlock;
struct URLBlock
{
String scheme;
String host;
String path; /* Path includes any parameter portion */
String query;
String fragment;
uint32_t port;
SchemeType scheme_type;
bool tls;
bool port_dflt;
};
extern void URLBlockInit ( URLBlock *self );
extern rc_t ParseUrl ( URLBlock * b, const char * url, size_t url_size );
#ifdef __cplusplus
}
#endif
#endif /* _h_kns_mgr_priv_ */
|