summaryrefslogtreecommitdiff
path: root/src/include/gnunet_configuration_lib.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_configuration_lib.h')
-rw-r--r--src/include/gnunet_configuration_lib.h208
1 files changed, 104 insertions, 104 deletions
diff --git a/src/include/gnunet_configuration_lib.h b/src/include/gnunet_configuration_lib.h
index a0e73f474..4d1bb6b79 100644
--- a/src/include/gnunet_configuration_lib.h
+++ b/src/include/gnunet_configuration_lib.h
@@ -11,12 +11,12 @@
11 WITHOUT ANY WARRANTY; without even the implied warranty of 11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details. 13 Affero General Public License for more details.
14 14
15 You should have received a copy of the GNU Affero General Public License 15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. 16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 17
18 SPDX-License-Identifier: AGPL3.0-or-later 18 SPDX-License-Identifier: AGPL3.0-or-later
19*/ 19 */
20 20
21/** 21/**
22 * @author Christian Grothoff 22 * @author Christian Grothoff
@@ -51,7 +51,7 @@ struct GNUNET_CONFIGURATION_Handle;
51 * @return fresh configuration object 51 * @return fresh configuration object
52 */ 52 */
53struct GNUNET_CONFIGURATION_Handle * 53struct GNUNET_CONFIGURATION_Handle *
54GNUNET_CONFIGURATION_create (void); 54GNUNET_CONFIGURATION_create(void);
55 55
56 56
57/** 57/**
@@ -61,7 +61,7 @@ GNUNET_CONFIGURATION_create (void);
61 * @return duplicate configuration 61 * @return duplicate configuration
62 */ 62 */
63struct GNUNET_CONFIGURATION_Handle * 63struct GNUNET_CONFIGURATION_Handle *
64GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg); 64GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg);
65 65
66 66
67/** 67/**
@@ -70,7 +70,7 @@ GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg);
70 * @param cfg configuration to destroy 70 * @param cfg configuration to destroy
71 */ 71 */
72void 72void
73GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg); 73GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg);
74 74
75 75
76/** 76/**
@@ -83,8 +83,8 @@ GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg);
83 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 83 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
84 */ 84 */
85int 85int
86GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg, 86GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg,
87 const char *filename); 87 const char *filename);
88 88
89 89
90/** 90/**
@@ -96,8 +96,8 @@ GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg,
96 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 96 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
97 */ 97 */
98int 98int
99GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg, 99GNUNET_CONFIGURATION_load_from(struct GNUNET_CONFIGURATION_Handle *cfg,
100 const char *defaults_d); 100 const char *defaults_d);
101 101
102 102
103/** 103/**
@@ -109,8 +109,8 @@ GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg,
109 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 109 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
110 */ 110 */
111int 111int
112GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg, 112GNUNET_CONFIGURATION_parse(struct GNUNET_CONFIGURATION_Handle *cfg,
113 const char *filename); 113 const char *filename);
114 114
115 115
116/** 116/**
@@ -122,8 +122,8 @@ GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
122 * present. This memory should be freed by the caller 122 * present. This memory should be freed by the caller
123 */ 123 */
124char * 124char *
125GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg, 125GNUNET_CONFIGURATION_serialize(const struct GNUNET_CONFIGURATION_Handle *cfg,
126 size_t *size); 126 size_t *size);
127 127
128 128
129/** 129/**
@@ -138,10 +138,10 @@ GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg,
138 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 138 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
139 */ 139 */
140int 140int
141GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg, 141GNUNET_CONFIGURATION_deserialize(struct GNUNET_CONFIGURATION_Handle *cfg,
142 const char *mem, 142 const char *mem,
143 size_t size, 143 size_t size,
144 const char *basedir); 144 const char *basedir);
145 145
146 146
147/** 147/**
@@ -152,8 +152,8 @@ GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg,
152 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 152 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
153 */ 153 */
154int 154int
155GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg, 155GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg,
156 const char *filename); 156 const char *filename);
157 157
158 158
159/** 159/**
@@ -164,9 +164,9 @@ GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
164 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 164 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
165 */ 165 */
166int 166int
167GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle *cfg_default, 167GNUNET_CONFIGURATION_write_diffs(const struct GNUNET_CONFIGURATION_Handle *cfg_default,
168 const struct GNUNET_CONFIGURATION_Handle *cfg_new, 168 const struct GNUNET_CONFIGURATION_Handle *cfg_new,
169 const char *filename); 169 const char *filename);
170 170
171 171
172/** 172/**
@@ -177,8 +177,8 @@ GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle *cfg_
177 * @return configuration with only the differences, never NULL 177 * @return configuration with only the differences, never NULL
178 */ 178 */
179struct GNUNET_CONFIGURATION_Handle * 179struct GNUNET_CONFIGURATION_Handle *
180GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle *cfg_default, 180GNUNET_CONFIGURATION_get_diff(const struct GNUNET_CONFIGURATION_Handle *cfg_default,
181 const struct GNUNET_CONFIGURATION_Handle *cfg_new); 181 const struct GNUNET_CONFIGURATION_Handle *cfg_new);
182 182
183 183
184/** 184/**
@@ -189,7 +189,7 @@ GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle *cfg_def
189 * @return #GNUNET_NO if clean, #GNUNET_YES if dirty, #GNUNET_SYSERR on error (i.e. last save failed) 189 * @return #GNUNET_NO if clean, #GNUNET_YES if dirty, #GNUNET_SYSERR on error (i.e. last save failed)
190 */ 190 */
191int 191int
192GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg); 192GNUNET_CONFIGURATION_is_dirty(const struct GNUNET_CONFIGURATION_Handle *cfg);
193 193
194 194
195/** 195/**
@@ -201,7 +201,7 @@ GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg);
201 */ 201 */
202typedef int 202typedef int
203(*GNUNET_CONFIGURATION_Callback)(void *cls, 203(*GNUNET_CONFIGURATION_Callback)(void *cls,
204 const struct GNUNET_CONFIGURATION_Handle *cfg); 204 const struct GNUNET_CONFIGURATION_Handle *cfg);
205 205
206 206
207/** 207/**
@@ -216,9 +216,9 @@ typedef int
216 * otherwise return value from @a cb. 216 * otherwise return value from @a cb.
217 */ 217 */
218int 218int
219GNUNET_CONFIGURATION_parse_and_run (const char *filename, 219GNUNET_CONFIGURATION_parse_and_run(const char *filename,
220 GNUNET_CONFIGURATION_Callback cb, 220 GNUNET_CONFIGURATION_Callback cb,
221 void *cb_cls); 221 void *cb_cls);
222 222
223 223
224/** 224/**
@@ -255,9 +255,9 @@ typedef void
255 * @param iter_cls closure for @a iter 255 * @param iter_cls closure for @a iter
256 */ 256 */
257void 257void
258GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg, 258GNUNET_CONFIGURATION_iterate(const struct GNUNET_CONFIGURATION_Handle *cfg,
259 GNUNET_CONFIGURATION_Iterator iter, 259 GNUNET_CONFIGURATION_Iterator iter,
260 void *iter_cls); 260 void *iter_cls);
261 261
262 262
263/** 263/**
@@ -268,9 +268,9 @@ GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
268 * @param iter_cls closure for @a iter 268 * @param iter_cls closure for @a iter
269 */ 269 */
270void 270void
271GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle *cfg, 271GNUNET_CONFIGURATION_iterate_sections(const struct GNUNET_CONFIGURATION_Handle *cfg,
272 GNUNET_CONFIGURATION_Section_Iterator iter, 272 GNUNET_CONFIGURATION_Section_Iterator iter,
273 void *iter_cls); 273 void *iter_cls);
274 274
275 275
276/** 276/**
@@ -280,8 +280,8 @@ GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle
280 * @param section name of the section to remove 280 * @param section name of the section to remove
281 */ 281 */
282void 282void
283GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg, 283GNUNET_CONFIGURATION_remove_section(struct GNUNET_CONFIGURATION_Handle *cfg,
284 const char *section); 284 const char *section);
285 285
286 286
287/** 287/**
@@ -294,10 +294,10 @@ GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg,
294 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 294 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
295 */ 295 */
296int 296int
297GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle *cfg, 297GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg,
298 const char *section, 298 const char *section,
299 const char *option, 299 const char *option,
300 unsigned long long *number); 300 unsigned long long *number);
301 301
302 302
303/** 303/**
@@ -310,10 +310,10 @@ GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
310 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 310 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
311 */ 311 */
312int 312int
313GNUNET_CONFIGURATION_get_value_float (const struct GNUNET_CONFIGURATION_Handle *cfg, 313GNUNET_CONFIGURATION_get_value_float(const struct GNUNET_CONFIGURATION_Handle *cfg,
314 const char *section, 314 const char *section,
315 const char *option, 315 const char *option,
316 float *number); 316 float *number);
317 317
318 318
319/** 319/**
@@ -326,10 +326,10 @@ GNUNET_CONFIGURATION_get_value_float (const struct GNUNET_CONFIGURATION_Handle
326 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 326 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
327 */ 327 */
328int 328int
329GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle *cfg, 329GNUNET_CONFIGURATION_get_value_time(const struct GNUNET_CONFIGURATION_Handle *cfg,
330 const char *section, 330 const char *section,
331 const char *option, 331 const char *option,
332 struct GNUNET_TIME_Relative *time); 332 struct GNUNET_TIME_Relative *time);
333 333
334 334
335 335
@@ -343,10 +343,10 @@ GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle *c
343 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 343 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
344 */ 344 */
345int 345int
346GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *cfg, 346GNUNET_CONFIGURATION_get_value_size(const struct GNUNET_CONFIGURATION_Handle *cfg,
347 const char *section, 347 const char *section,
348 const char *option, 348 const char *option,
349 unsigned long long *size); 349 unsigned long long *size);
350 350
351 351
352/** 352/**
@@ -358,9 +358,9 @@ GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *c
358 * @return #GNUNET_YES if so, #GNUNET_NO if not. 358 * @return #GNUNET_YES if so, #GNUNET_NO if not.
359 */ 359 */
360int 360int
361GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg, 361GNUNET_CONFIGURATION_have_value(const struct GNUNET_CONFIGURATION_Handle *cfg,
362 const char *section, 362 const char *section,
363 const char *option); 363 const char *option);
364 364
365 365
366/** 366/**
@@ -374,10 +374,10 @@ GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
374 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 374 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
375 */ 375 */
376int 376int
377GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle *cfg, 377GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg,
378 const char *section, 378 const char *section,
379 const char *option, 379 const char *option,
380 char **value); 380 char **value);
381 381
382 382
383/** 383/**
@@ -392,10 +392,10 @@ GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle
392 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 392 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
393 */ 393 */
394int 394int
395GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle *cfg, 395GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg,
396 const char *section, 396 const char *section,
397 const char *option, 397 const char *option,
398 char **value); 398 char **value);
399 399
400 400
401/** 401/**
@@ -409,11 +409,11 @@ GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handl
409 * @return number of filenames iterated over, -1 on error 409 * @return number of filenames iterated over, -1 on error
410 */ 410 */
411int 411int
412GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_Handle *cfg, 412GNUNET_CONFIGURATION_iterate_value_filenames(const struct GNUNET_CONFIGURATION_Handle *cfg,
413 const char *section, 413 const char *section,
414 const char *option, 414 const char *option,
415 GNUNET_FileNameCallback cb, 415 GNUNET_FileNameCallback cb,
416 void *cb_cls); 416 void *cb_cls);
417 417
418/** 418/**
419 * Iterate over values of a section in the configuration. 419 * Iterate over values of a section in the configuration.
@@ -424,10 +424,10 @@ GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_
424 * @param iter_cls closure for @a iter 424 * @param iter_cls closure for @a iter
425 */ 425 */
426void 426void
427GNUNET_CONFIGURATION_iterate_section_values (const struct GNUNET_CONFIGURATION_Handle *cfg, 427GNUNET_CONFIGURATION_iterate_section_values(const struct GNUNET_CONFIGURATION_Handle *cfg,
428 const char *section, 428 const char *section,
429 GNUNET_CONFIGURATION_Iterator iter, 429 GNUNET_CONFIGURATION_Iterator iter,
430 void *iter_cls); 430 void *iter_cls);
431 431
432/** 432/**
433 * Get a configuration value that should be in a set of 433 * Get a configuration value that should be in a set of
@@ -442,11 +442,11 @@ GNUNET_CONFIGURATION_iterate_section_values (const struct GNUNET_CONFIGURATION_H
442 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error 442 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
443 */ 443 */
444int 444int
445GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle *cfg, 445GNUNET_CONFIGURATION_get_value_choice(const struct GNUNET_CONFIGURATION_Handle *cfg,
446 const char *section, 446 const char *section,
447 const char *option, 447 const char *option,
448 const char *const *choices, 448 const char *const *choices,
449 const char **value); 449 const char **value);
450 450
451/** 451/**
452 * Get a configuration value that should be in a set of 452 * Get a configuration value that should be in a set of
@@ -458,9 +458,9 @@ GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle
458 * @return #GNUNET_YES, #GNUNET_NO or if option has no valid value, #GNUNET_SYSERR 458 * @return #GNUNET_YES, #GNUNET_NO or if option has no valid value, #GNUNET_SYSERR
459 */ 459 */
460int 460int
461GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg, 461GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg,
462 const char *section, 462 const char *section,
463 const char *option); 463 const char *option);
464 464
465 465
466/** 466/**
@@ -476,11 +476,11 @@ GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *
476 * #GNUNET_SYSERR on decoding error 476 * #GNUNET_SYSERR on decoding error
477 */ 477 */
478int 478int
479GNUNET_CONFIGURATION_get_data (const struct GNUNET_CONFIGURATION_Handle *cfg, 479GNUNET_CONFIGURATION_get_data(const struct GNUNET_CONFIGURATION_Handle *cfg,
480 const char *section, 480 const char *section,
481 const char *option, 481 const char *option,
482 void *buf, 482 void *buf,
483 size_t buf_size); 483 size_t buf_size);
484 484
485 485
486/** 486/**
@@ -500,8 +500,8 @@ GNUNET_CONFIGURATION_get_data (const struct GNUNET_CONFIGURATION_Handle *cfg,
500 * @return $-expanded string 500 * @return $-expanded string
501 */ 501 */
502char * 502char *
503GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg, 503GNUNET_CONFIGURATION_expand_dollar(const struct GNUNET_CONFIGURATION_Handle *cfg,
504 char *orig); 504 char *orig);
505 505
506 506
507/** 507/**
@@ -513,10 +513,10 @@ GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cf
513 * @param number value to set 513 * @param number value to set
514 */ 514 */
515void 515void
516GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle *cfg, 516GNUNET_CONFIGURATION_set_value_number(struct GNUNET_CONFIGURATION_Handle *cfg,
517 const char *section, 517 const char *section,
518 const char *option, 518 const char *option,
519 unsigned long long number); 519 unsigned long long number);
520 520
521 521
522/** 522/**
@@ -528,10 +528,10 @@ GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle *cfg,
528 * @param value value to set 528 * @param value value to set
529 */ 529 */
530void 530void
531GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle *cfg, 531GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg,
532 const char *section, 532 const char *section,
533 const char *option, 533 const char *option,
534 const char *value); 534 const char *value);
535 535
536 536
537/** 537/**
@@ -546,10 +546,10 @@ GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle *cfg,
546 * #GNUNET_SYSERR if the filename is not in the list 546 * #GNUNET_SYSERR if the filename is not in the list
547 */ 547 */
548int 548int
549GNUNET_CONFIGURATION_remove_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg, 549GNUNET_CONFIGURATION_remove_value_filename(struct GNUNET_CONFIGURATION_Handle *cfg,
550 const char *section, 550 const char *section,
551 const char *option, 551 const char *option,
552 const char *value); 552 const char *value);
553 553
554 554
555/** 555/**
@@ -564,10 +564,10 @@ GNUNET_CONFIGURATION_remove_value_filename (struct GNUNET_CONFIGURATION_Handle *
564 * #GNUNET_SYSERR if the filename already in the list 564 * #GNUNET_SYSERR if the filename already in the list
565 */ 565 */
566int 566int
567GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg, 567GNUNET_CONFIGURATION_append_value_filename(struct GNUNET_CONFIGURATION_Handle *cfg,
568 const char *section, 568 const char *section,
569 const char *option, 569 const char *option,
570 const char *value); 570 const char *value);
571 571
572#if 0 /* keep Emacsens' auto-indent happy */ 572#if 0 /* keep Emacsens' auto-indent happy */
573{ 573{