as discussed with kevin, move
[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-2005, Mark Spencer
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 #define DEFAULT_LANGUAGE "en"
22
23 #define DEFAULT_SAMPLE_RATE 8000
24 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
25
26 #define AST_CONFIG_MAX_PATH 255
27
28 /* provided in asterisk.c */
29 extern char ast_config_AST_CONFIG_DIR[AST_CONFIG_MAX_PATH];
30 extern char ast_config_AST_CONFIG_FILE[AST_CONFIG_MAX_PATH];
31 extern char ast_config_AST_MODULE_DIR[AST_CONFIG_MAX_PATH];
32 extern char ast_config_AST_SPOOL_DIR[AST_CONFIG_MAX_PATH];
33 extern char ast_config_AST_MONITOR_DIR[AST_CONFIG_MAX_PATH];
34 extern char ast_config_AST_VAR_DIR[AST_CONFIG_MAX_PATH];
35 extern char ast_config_AST_LOG_DIR[AST_CONFIG_MAX_PATH];
36 extern char ast_config_AST_AGI_DIR[AST_CONFIG_MAX_PATH];
37 extern char ast_config_AST_DB[AST_CONFIG_MAX_PATH];
38 extern char ast_config_AST_KEY_DIR[AST_CONFIG_MAX_PATH];
39 extern char ast_config_AST_PID[AST_CONFIG_MAX_PATH];
40 extern char ast_config_AST_SOCKET[AST_CONFIG_MAX_PATH];
41 extern char ast_config_AST_RUN_DIR[AST_CONFIG_MAX_PATH];
42 extern char ast_config_AST_CTL_PERMISSIONS[AST_CONFIG_MAX_PATH];
43 extern char ast_config_AST_CTL_OWNER[AST_CONFIG_MAX_PATH];
44 extern char ast_config_AST_CTL_GROUP[AST_CONFIG_MAX_PATH];
45 extern char ast_config_AST_CTL[AST_CONFIG_MAX_PATH];
46 extern char ast_config_AST_SYSTEM_NAME[20];
47
48 /* Provided by asterisk.c */
49 int ast_set_priority(int);
50 /* Provided by module.c */
51 int load_modules(const int preload_only);
52 /* Provided by pbx.c */
53 int load_pbx(void);
54 /* Provided by logger.c */
55 int init_logger(void);
56 void close_logger(void);
57 /* Provided by frame.c */
58 int init_framer(void);
59 /* Provided by logger.c */
60 int reload_logger(int);
61 /* Provided by term.c */
62 int term_init(void);
63 /* Provided by db.c */
64 int astdb_init(void);
65 /* Provided by channel.c */
66 void ast_channels_init(void);
67 /* Provided by cli.c */
68 void ast_builtins_init(void);
69 /* Provided by dnsmgr.c */
70 int dnsmgr_init(void);
71 void dnsmgr_start_refresh(void);
72 int dnsmgr_reload(void);
73
74 /*!
75  * \brief Register a function to be executed before Asterisk exits.
76  * \param func The callback function to use.
77  * 
78  * \return Zero on success, -1 on error.
79  */
80 int ast_register_atexit(void (*func)(void));
81  
82 /*!
83  * \brief Unregister a function registered with ast_register_atexit().
84  * \param func The callback function to unregister.
85  */
86 void ast_unregister_atexit(void (*func)(void));
87
88 /*!
89  * \brief Register the version of a source code file with the core.
90  * \param file the source file name
91  * \param version the version string (typically a CVS revision keyword string)
92  * \return nothing
93  *
94  * This function should not be called directly, but instead the
95  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
96  */
97 void ast_register_file_version(const char *file, const char *version);
98
99 /*!
100  * \brief Unregister a source code file from the core.
101  * \param file the source file name
102  * \return nothing
103  *
104  * This function should not be called directly, but instead the
105  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
106  * the file when the module is unloaded.
107  */
108 void ast_unregister_file_version(const char *file);
109
110 /*!
111  * \brief Register/unregister a source code file with the core.
112  * \param file the source file name
113  * \param version the version string (typically a CVS revision keyword string)
114  *
115  * This macro will place a file-scope constructor and destructor into the
116  * source of the module using it; this will cause the version of this file
117  * to registered with the Asterisk core (and unregistered) at the appropriate
118  * times.
119  *
120  * Example:
121  *
122  * \code
123  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
124  * \endcode
125  *
126  * \note The dollar signs above have been protected with backslashes to keep
127  * CVS from modifying them in this file; under normal circumstances they would
128  * not be present and CVS would expand the Revision keyword into the file's
129  * revision number.
130  */
131 #if defined(__GNUC__) && !defined(LOW_MEMORY)
132 #define ASTERISK_FILE_VERSION(file, version) \
133         static void __attribute__((constructor)) __register_file_version(void) \
134         { \
135                 ast_register_file_version(file, version); \
136         } \
137         static void __attribute__((destructor)) __unregister_file_version(void) \
138         { \
139                 ast_unregister_file_version(file); \
140         }
141 #elif !defined(LOW_MEMORY) /* ! __GNUC__  && ! LOW_MEMORY*/
142 #define ASTERISK_FILE_VERSION(file, x) static const char __file_version[] = x;
143 #else /* LOW_MEMORY */
144 #define ASTERISK_FILE_VERSION(file, x)
145 #endif /* __GNUC__ */
146
147 #endif /* _ASTERISK_H */