Doxygen additions, corrections
[asterisk/asterisk.git] / include / asterisk.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * General Definitions for Asterisk top level program
5  * 
6  * Copyright (C) 1999-2006, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 /*! \file
15  * \brief Asterisk main include file. File version handling, generic pbx functions.
16  */
17
18 #ifndef _ASTERISK_H
19 #define _ASTERISK_H
20
21 /* The include of 'autoconfig.h' is not necessary for any modules that
22    are part of the Asterisk source tree, because the top-level Makefile
23    will forcibly include that header in all compilations before all
24    other headers (even system headers). However, leaving this here will
25    help out-of-tree module builders, and doesn't cause any harm for the
26    in-tree modules.
27 */
28 #include "asterisk/autoconfig.h"
29
30 #include "asterisk/compat.h"
31
32 #include "asterisk/paths.h"
33
34 /* Default to allowing the umask or filesystem ACLs to determine actual file
35  * creation permissions
36  */
37 #ifndef AST_DIR_MODE
38 #define AST_DIR_MODE 0777
39 #endif
40 #ifndef AST_FILE_MODE
41 #define AST_FILE_MODE 0666
42 #endif
43
44 #define DEFAULT_LANGUAGE "en"
45
46 #define DEFAULT_SAMPLE_RATE 8000
47 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
48
49 /* provided in asterisk.c */
50 extern char ast_config_AST_CONFIG_DIR[PATH_MAX];
51 extern char ast_config_AST_CONFIG_FILE[PATH_MAX];
52 extern char ast_config_AST_MODULE_DIR[PATH_MAX];
53 extern char ast_config_AST_SPOOL_DIR[PATH_MAX];
54 extern char ast_config_AST_MONITOR_DIR[PATH_MAX];
55 extern char ast_config_AST_VAR_DIR[PATH_MAX];
56 extern char ast_config_AST_DATA_DIR[PATH_MAX];
57 extern char ast_config_AST_LOG_DIR[PATH_MAX];
58 extern char ast_config_AST_AGI_DIR[PATH_MAX];
59 extern char ast_config_AST_DB[PATH_MAX];
60 extern char ast_config_AST_KEY_DIR[PATH_MAX];
61 extern char ast_config_AST_PID[PATH_MAX];
62 extern char ast_config_AST_SOCKET[PATH_MAX];
63 extern char ast_config_AST_RUN_DIR[PATH_MAX];
64 extern char ast_config_AST_CTL_PERMISSIONS[PATH_MAX];
65 extern char ast_config_AST_CTL_OWNER[PATH_MAX];
66 extern char ast_config_AST_CTL_GROUP[PATH_MAX];
67 extern char ast_config_AST_CTL[PATH_MAX];
68 extern char ast_config_AST_SYSTEM_NAME[20];
69
70 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
71 int load_modules(unsigned int);                 /*!< Provided by loader.c */
72 int load_pbx(void);                             /*!< Provided by pbx.c */
73 int init_logger(void);                          /*!< Provided by logger.c */
74 void close_logger(void);                        /*!< Provided by logger.c */
75 int reload_logger(int);                         /*!< Provided by logger.c */
76 int init_framer(void);                          /*!< Provided by frame.c */
77 int ast_term_init(void);                        /*!< Provided by term.c */
78 int astdb_init(void);                           /*!< Provided by db.c */
79 void ast_channels_init(void);                   /*!< Provided by channel.c */
80 void ast_builtins_init(void);                   /*!< Provided by cli.c */
81 int dnsmgr_init(void);                          /*!< Provided by dnsmgr.c */ 
82 void dnsmgr_start_refresh(void);                /*!< Provided by dnsmgr.c */
83 int dnsmgr_reload(void);                        /*!< Provided by dnsmgr.c */
84 void threadstorage_init(void);                  /*!< Provided by threadstorage.c */
85
86 /* Many headers need 'ast_channel' to be defined */
87 struct ast_channel;
88
89 /* Many headers need 'ast_module' to be defined */
90 struct ast_module;
91
92 /*!
93  * \brief Reload asterisk modules.
94  * \param name the name of the module to reload
95  *
96  * This function reloads the specified module, or if no modules are specified,
97  * it will reload all loaded modules.
98  *
99  * \note Modules are reloaded using their reload() functions, not unloading
100  * them and loading them again.
101  * 
102  * \return Zero if the specified module was not found, 1 if the module was
103  * found but cannot be reloaded, -1 if a reload operation is already in
104  * progress, and 2 if the specfied module was found and reloaded.
105  */
106 int ast_module_reload(const char *name);
107
108 /*!
109  * \brief Register a function to be executed before Asterisk exits.
110  * \param func The callback function to use.
111  *
112  * \return Zero on success, -1 on error.
113  */
114 int ast_register_atexit(void (*func)(void));
115
116 /*!   
117  * \brief Unregister a function registered with ast_register_atexit().
118  * \param func The callback function to unregister.   
119  */
120 void ast_unregister_atexit(void (*func)(void));
121
122 #if !defined(LOW_MEMORY)
123 /*!
124  * \brief Register the version of a source code file with the core.
125  * \param file the source file name
126  * \param version the version string (typically a CVS revision keyword string)
127  * \return nothing
128  *
129  * This function should not be called directly, but instead the
130  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
131  */
132 void ast_register_file_version(const char *file, const char *version);
133
134 /*!
135  * \brief Unregister a source code file from the core.
136  * \param file the source file name
137  * \return nothing
138  *
139  * This function should not be called directly, but instead the
140  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
141  * the file when the module is unloaded.
142  */
143 void ast_unregister_file_version(const char *file);
144
145 /*!
146  * \brief Register/unregister a source code file with the core.
147  * \param file the source file name
148  * \param version the version string (typically a CVS revision keyword string)
149  *
150  * This macro will place a file-scope constructor and destructor into the
151  * source of the module using it; this will cause the version of this file
152  * to registered with the Asterisk core (and unregistered) at the appropriate
153  * times.
154  *
155  * Example:
156  *
157  * \code
158  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
159  * \endcode
160  *
161  * \note The dollar signs above have been protected with backslashes to keep
162  * CVS from modifying them in this file; under normal circumstances they would
163  * not be present and CVS would expand the Revision keyword into the file's
164  * revision number.
165  */
166 #ifdef MTX_PROFILE
167 #define HAVE_MTX_PROFILE        /* used in lock.h */
168 #define ASTERISK_FILE_VERSION(file, version) \
169         static int mtx_prof = -1;       /* profile mutex */     \
170         static void __attribute__((constructor)) __register_file_version(void) \
171         { \
172                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
173                 ast_register_file_version(file, version); \
174         } \
175         static void __attribute__((destructor)) __unregister_file_version(void) \
176         { \
177                 ast_unregister_file_version(file); \
178         }
179 #else /* !MTX_PROFILE */
180 #define ASTERISK_FILE_VERSION(file, version) \
181         static void __attribute__((constructor)) __register_file_version(void) \
182         { \
183                 ast_register_file_version(file, version); \
184         } \
185         static void __attribute__((destructor)) __unregister_file_version(void) \
186         { \
187                 ast_unregister_file_version(file); \
188         }
189 #endif /* !MTX_PROFILE */
190 #else /* LOW_MEMORY */
191 #define ASTERISK_FILE_VERSION(file, x)
192 #endif /* LOW_MEMORY */
193
194 #if !defined(LOW_MEMORY)
195 /*!
196  * \brief support for event profiling
197  *
198  * (note, this must be documented a lot more)
199  * ast_add_profile allocates a generic 'counter' with a given name,
200  * which can be shown with the command 'show profile <name>'
201  *
202  * The counter accumulates positive or negative values supplied by
203  * ast_add_profile(), dividing them by the 'scale' value passed in the
204  * create call, and also counts the number of 'events'.
205  * Values can also be taked by the TSC counter on ia32 architectures,
206  * in which case you can mark the start of an event calling ast_mark(id, 1)
207  * and then the end of the event with ast_mark(id, 0).
208  * For non-i386 architectures, these two calls return 0.
209  */
210 int ast_add_profile(const char *, uint64_t scale);
211 int64_t ast_profile(int, int64_t);
212 int64_t ast_mark(int, int start1_stop0);
213 #else /* LOW_MEMORY */
214 #define ast_add_profile(a, b) 0
215 #define ast_profile(a, b) do { } while (0)
216 #define ast_mark(a, b) do { } while (0)
217 #endif /* LOW_MEMORY */
218
219 #endif /* _ASTERISK_H */