← Back to branch summary

~clint-fewbar/ubuntu/precise/gearmand/drop-unneeded-patches

« back to all changes in this revision

Viewing changes to libgearman-server/conf_module.h

  • Committer: Bazaar Package Importer
  • Author(s): Monty Taylor
  • Date: 2009-09-28 21:43:31 UTC
  • mto: (1.2.3 upstream) (6.1.1 sid)
  • mto: This revision was merged to the branch mainline in revision 5.
  • Revision ID: james.westby@ubuntu.com-20090928214331-9bku0d3v1b1ypgp4
Import upstream version 0.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
libgearman-server/conf_module.h
 
1
/* Module configuration library
 
2
 * Copyright (C) 2009 Eric Day
 
3
 * All rights reserved.
 
4
 *
 
5
 * Use and distribution licensed under the BSD license.  See
 
6
 * the COPYING file in the parent directory for full text.
 
7
 */
 
8
 
 
9
/**
 
10
 * @file
 
11
 * @brief Gearman conf module declarations
 
12
 */
 
13
 
 
14
#ifndef __GEARMAN_SERVER_CONF_MODULE_H__
 
15
#define __GEARMAN_SERVER_CONF_MODULE_H__
 
16
 
 
17
#ifdef __cplusplus
 
18
extern "C" {
 
19
#endif
 
20
 
 
21
/**
 
22
 * @addtogroup gearman_conf_module Gearman conf module interface
 
23
 * @{
 
24
 */
 
25
 
 
26
/**
 
27
 * Initialize a gearman conf module structure.
 
28
 */
 
29
GEARMAN_API
 
30
gearman_conf_module_st *gearman_conf_module_create(gearman_conf_st *conf,
 
31
                                                 gearman_conf_module_st *module,
 
32
                                                 const char *name);
 
33
 
 
34
/**
 
35
 * Free a gearman conf module structure.
 
36
 */
 
37
GEARMAN_API
 
38
void gearman_conf_module_free(gearman_conf_module_st *module);
 
39
 
 
40
/**
 
41
 * Find a gearman conf module structure by name.
 
42
 */
 
43
GEARMAN_API
 
44
gearman_conf_module_st *gearman_conf_module_find(gearman_conf_st *conf,
 
45
                                                 const char *name);
 
46
 
 
47
/**
 
48
 * Add option for a module.
 
49
 */
 
50
GEARMAN_API
 
51
void gearman_conf_module_add_option(gearman_conf_module_st *module,
 
52
                                    const char *name, int short_name,
 
53
                                    const char *value_name, const char *help);
 
54
 
 
55
/**
 
56
 * Loop through all values that were given for a set of module options.
 
57
 */
 
58
GEARMAN_API
 
59
bool gearman_conf_module_value(gearman_conf_module_st *module,
 
60
                               const char **name, const char **value);
 
61
 
 
62
/** @} */
 
63
 
 
64
#ifdef __cplusplus
 
65
}
 
66
#endif
 
67
 
 
68
#endif /* __GEARMAN_SERVER_CONF_MODULE_H__ */