Grid Community Toolkit  6.2.1705709074 (tag: v6.2.20240202)
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
globus_error_generic.h
Go to the documentation of this file.
1 /*
2  * Copyright 1999-2006 University of Chicago
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
22 #ifndef GLOBUS_ERROR_GENERIC_H
23 #define GLOBUS_ERROR_GENERIC_H
24 
25 #include "globus_object.h"
26 #include "globus_module.h"
27 
28 #include <stdarg.h>
29 
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81 
98 #define GLOBUS_ERROR_TYPE_GLOBUS (&GLOBUS_ERROR_TYPE_GLOBUS_DEFINITION)
99 extern const globus_object_type_t GLOBUS_ERROR_TYPE_GLOBUS_DEFINITION;
100 
101 #ifndef DOXYGEN
102 
103 globus_object_t *
105  globus_module_descriptor_t * base_source,
106  globus_object_t * base_cause,
107  int type,
108  const char * source_file,
109  const char * source_func,
110  int source_line,
111  const char * short_desc_format,
112  ...);
113 
114 globus_object_t *
116  globus_module_descriptor_t * base_source,
117  globus_object_t * base_cause,
118  int type,
119  const char * source_file,
120  const char * source_func,
121  int source_line,
122  const char * short_desc_format,
123  va_list ap);
124 
125 globus_object_t *
127  globus_object_t * error,
128  globus_module_descriptor_t * base_source,
129  globus_object_t * base_cause,
130  int type,
131  const char * source_file,
132  const char * source_func,
133  int source_line,
134  const char * short_desc_format,
135  va_list ap);
136 
137 #endif
138 
152  globus_object_t * error);
153 
154 void
156  globus_object_t * error,
157  globus_module_descriptor_t * source_module);
158 
159 globus_object_t *
161  globus_object_t * error);
162 
163 void
165  globus_object_t * error,
166  globus_object_t * causal_error);
167 
168 int
170  globus_object_t * error);
171 
172 void
174  globus_object_t * error,
175  const int type);
176 
177 char *
179  globus_object_t * error);
180 
181 void
183  globus_object_t * error,
184  const char * short_desc_format,
185  ...);
186 
187 char *
189  globus_object_t * error);
190 
191 void
193  globus_object_t * error,
194  const char * long_desc_format,
195  ...);
196 
210  globus_object_t * error,
212  int type);
213 
214 char *
216  globus_object_t * error);
217 
218 char *
220  globus_object_t * error);
221 
249 typedef char * (*globus_error_print_friendly_t)(
250  globus_object_t * error,
251  const globus_object_type_t * type);
252 
253 
254 #define GLOBUS_ERROR_TYPE_MULTIPLE (&GLOBUS_ERROR_TYPE_MULTIPLE_DEFINITION)
255 extern const globus_object_type_t GLOBUS_ERROR_TYPE_MULTIPLE_DEFINITION;
256 
257 globus_object_t *
259  globus_module_descriptor_t * base_source,
260  int type,
261  const char * fmt,
262  ...);
263 
264 void
266  globus_object_t * multiple_error,
267  globus_object_t * chain,
268  const char * fmt,
269  ...);
270 
271 globus_object_t *
273  globus_object_t * multiple_error);
274 
275 #ifdef __cplusplus
276 }
277 #endif
278 
279 #endif /* GLOBUS_ERROR_GENERIC_H */
void globus_error_mutliple_add_chain(globus_object_t *multiple_error, globus_object_t *chain, const char *fmt,...)
Definition: globus_error_generic.c:1157
int globus_error_get_type(globus_object_t *error)
Definition: globus_error_generic.c:393
globus_object_t * globus_error_get_cause(globus_object_t *error)
Definition: globus_error_generic.c:346
globus_object_t * globus_error_construct_multiple(globus_module_descriptor_t *base_source, int type, const char *fmt,...)
Definition: globus_error_generic.c:1077
globus_object_t * globus_error_multiple_remove_chain(globus_object_t *multiple_error)
Definition: globus_error_generic.c:1213
int globus_bool_t
Boolean type.
Definition: globus_types.h:93
Reference Counting Module Activation and Deactivation.
globus_object_t * globus_error_construct_error(globus_module_descriptor_t *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,...)
Definition: globus_error_generic.c:85
void globus_error_set_long_desc(globus_object_t *error, const char *long_desc_format,...)
Definition: globus_error_generic.c:592
globus_bool_t globus_error_match(globus_object_t *error, globus_module_descriptor_t *module, int type)
Definition: globus_error_generic.c:667
void globus_error_set_short_desc(globus_object_t *error, const char *short_desc_format,...)
Definition: globus_error_generic.c:496
void globus_error_set_cause(globus_object_t *error, globus_object_t *causal_error)
Definition: globus_error_generic.c:370
char * globus_error_print_friendly(globus_object_t *error)
Definition: globus_error_generic.c:920
char * globus_error_get_short_desc(globus_object_t *error)
Definition: globus_error_generic.c:461
void globus_error_set_type(globus_object_t *error, const int type)
Definition: globus_error_generic.c:431
char * globus_error_print_chain(globus_object_t *error)
Definition: globus_error_generic.c:735
char * globus_error_get_long_desc(globus_object_t *error)
Definition: globus_error_generic.c:562
globus_module_descriptor_t * globus_error_get_source(globus_object_t *error)
Definition: globus_error_generic.c:300
globus_object_t * globus_error_initialize_error(globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)
Definition: globus_error_generic.c:225
globus_object_t * globus_error_v_construct_error(globus_module_descriptor_t *base_source, globus_object_t *base_cause, const int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)
Definition: globus_error_generic.c:154
void globus_error_set_source(globus_object_t *error, globus_module_descriptor_t *source_module)
Definition: globus_error_generic.c:323
Module Descriptor.
Definition: globus_module.h:71