/usr/include/globus/globus_module.h is in libglobus-common-dev 16.9-1.
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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | /*
* Copyright 1999-2006 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.
*/
/**
* @file globus_module.h
* @brief Reference Counting Module Activation and Deactivation
*/
#if !defined(GLOBUS_MODULE_H)
#define GLOBUS_MODULE_H 1
/** @defgroup globus_module Module Activation Management
* @ingroup globus_common
*/
/**
* @ingroup globus_module
*/
/*@{*/
struct globus_module_descriptor_s;
typedef struct globus_module_descriptor_s globus_module_descriptor_t;
/*@}*/
#include "globus_error_generic.h"
#include <stdio.h>
#ifdef __cplusplus
extern "C" {
#endif
/******************************************************************************
Type definitions
******************************************************************************/
typedef int (*globus_module_activation_func_t)(void);
typedef int (*globus_module_deactivation_func_t)(void);
typedef void (*globus_module_atexit_func_t)(void);
typedef void * (*globus_module_get_pointer_func_t)(void);
typedef struct
{
int major;
int minor;
/* these two members are reserved for internal Globus components */
unsigned long timestamp;
int branch_id;
} globus_version_t;
/**
* @brief Module Descriptor
* @ingroup globus_module
* @details
* Public data structure which contains function pointers to activate
* deactivate a module.
*/
struct globus_module_descriptor_s
{
/** Module name string */
char * module_name;
/** Module activation function */
globus_module_activation_func_t activation_func;
/** Module deactivation function */
globus_module_deactivation_func_t deactivation_func;
/** Module atexit function */
globus_module_atexit_func_t atexit_func;
/** Module get_pointer function */
globus_module_get_pointer_func_t get_pointer_func;
/** Module version */
globus_version_t * version;
/** Module error message function */
globus_error_print_friendly_t friendly_error_func;
};
/******************************************************************************
Function prototypes
******************************************************************************/
/*
* NOTE: all functions return either GLOBUS_SUCCESS or an error code
*/
int
globus_module_activate(
globus_module_descriptor_t * module_descriptor);
int
globus_module_activate_array(
globus_module_descriptor_t * modules[],
globus_module_descriptor_t ** failed_module);
int
globus_module_deactivate(
globus_module_descriptor_t * module_descriptor);
int
globus_module_deactivate_all(void);
/**
* module must be deactivated in this call with
* module_descriptor->deactivation_func();
* (be sure module_descriptor->deactivation_func is !NULL)
*/
typedef
int
(*globus_module_deactivate_proxy_cb_t)(
globus_module_descriptor_t * module_descriptor,
void * user_arg);
/**
* this call registers a callback to be called to handle deactivation when
* globus_module_deactivate() or globus_module_deactivate_all() is called
*
* The callback is only respected for the first call to activate this module.
* The purpose of these proxy calls is to allow 'private' module descriptors
* that are activated by some other user function, but may still be affected
* by deactivate_all().
*/
int
globus_module_activate_proxy(
globus_module_descriptor_t * module_descriptor,
globus_module_deactivate_proxy_cb_t deactivate_cb,
void * user_arg);
/**
* set an environment variable
*/
void
globus_module_setenv(
const char * name,
const char * value);
/**
* Get the value of an environment variable
*/
char *
globus_module_getenv(
const char * name);
/**
* Get a module pointer
*/
void *
globus_module_get_module_pointer(
globus_module_descriptor_t *);
int
globus_module_get_version(
globus_module_descriptor_t * module_descriptor,
globus_version_t * version);
void
globus_module_print_version(
globus_module_descriptor_t * module_descriptor,
FILE * stream,
globus_bool_t verbose);
void
globus_module_print_activated_versions(
FILE * stream,
globus_bool_t verbose);
void
globus_version_print(
const char * name,
const globus_version_t * version,
FILE * stream,
globus_bool_t verbose);
void
globus_module_set_args(
int * argc,
char *** argv);
void
globus_module_get_args(
int ** argc,
char **** argv);
#ifdef __cplusplus
}
#endif
#endif /* GLOBUS_MODULE_H */
|