File: cloud.h

package info (click to toggle)
ncbi-vdb 3.2.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,776 kB
  • sloc: ansic: 304,815; cpp: 75,250; python: 5,402; perl: 3,438; yacc: 2,225; sh: 689; lex: 574; makefile: 428; xml: 4
file content (95 lines) | stat: -rw-r--r-- 3,004 bytes parent folder | download | duplicates (3)
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
#ifndef _h_cloud_cloud_
#define _h_cloud_cloud_

/*==============================================================================
*
*                            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_cloud_extern_
#include <cloud/extern.h>
#endif

#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* forwards
 */
struct String;
struct KClientHttpRequest;

/* Cloud
 *  generic cloud interface
 */
typedef struct Cloud Cloud;

/* AddRef
 * Release
 */
CLOUD_EXTERN rc_t CC CloudAddRef ( const Cloud * self );
CLOUD_EXTERN rc_t CC CloudRelease ( const Cloud * self );

/* MakeComputeEnvironmentToken
 *  contact cloud provider to get proof of execution environment in form of a token
 */
CLOUD_EXTERN rc_t CC CloudMakeComputeEnvironmentToken ( const Cloud * self,
    struct String const ** ce_token );

/* GetLocation
 *  get cloud location in form proovider.zone
 */
CLOUD_EXTERN rc_t CC CloudGetLocation ( const Cloud * self,
    struct String const ** location );

/* AddComputeEnvironmentTokenForSigner
 *  prepare a request object with a compute environment token
 *  for use by an SDL-associated "signer" service
 */
CLOUD_EXTERN rc_t CC CloudAddComputeEnvironmentTokenForSigner ( const Cloud * self,
    struct KClientHttpRequest * req );

/* AddAuthentication
 *  prepare a request object with credentials for authentication
 */
CLOUD_EXTERN rc_t CC CloudAddAuthentication ( const Cloud * self,
    struct KClientHttpRequest * req, const char * http_method );

/* AddUserPaysCredentials
 *  prepare a request object with credentials for user-pays
 *
 *  fails if user has not explicitly accepted responsibility to pay
 *  by updating VDB configuration.
 */
CLOUD_EXTERN rc_t CC CloudAddUserPaysCredentials ( const Cloud * self,
    struct KClientHttpRequest * req, const char * http_method );

#ifdef __cplusplus
}
#endif

#endif /* _h_cloud_cloud_ */