res_rtp: Fix regression when IPv6 is not available.
[asterisk/asterisk.git] / include / asterisk.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
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 #include "asterisk/autoconfig.h"
22
23 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE) && !defined(STANDALONE2) && defined(MALLOC_DEBUG)
24 #include "asterisk/astmm.h"
25 #endif
26
27 #include "asterisk/compat.h"
28
29 /* Default to allowing the umask or filesystem ACLs to determine actual file
30  * creation permissions
31  */
32 #ifndef AST_DIR_MODE
33 #define AST_DIR_MODE 0777
34 #endif
35 #ifndef AST_FILE_MODE
36 #define AST_FILE_MODE 0666
37 #endif
38
39 /* Make sure PATH_MAX is defined on platforms (HURD) that don't define it.
40  * Also be sure to handle the case of a path larger than PATH_MAX
41  * (err safely) in the code.
42  */
43 #ifndef PATH_MAX
44 #define PATH_MAX 4096
45 #endif
46
47
48 #define DEFAULT_LANGUAGE "en"
49
50 #define DEFAULT_SAMPLE_RATE 8000
51 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
52 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
53 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
54
55 #if defined(DEBUG_FD_LEAKS) && !defined(STANDALONE) && !defined(STANDALONE2) && !defined(STANDALONE_AEL)
56 /* These includes are all about ordering */
57 #include <stdio.h>
58 #include <sys/types.h>
59 #include <sys/stat.h>
60 #include <sys/socket.h>
61 #include <fcntl.h>
62
63 #define open(a,...)     __ast_fdleak_open(__FILE__,__LINE__,__PRETTY_FUNCTION__, a, __VA_ARGS__)
64 #define pipe(a)         __ast_fdleak_pipe(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
65 #define socket(a,b,c)   __ast_fdleak_socket(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
66 #define close(a)        __ast_fdleak_close(a)
67 #define fopen(a,b)      __ast_fdleak_fopen(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
68 #define fclose(a)       __ast_fdleak_fclose(a)
69 #define dup2(a,b)       __ast_fdleak_dup2(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
70 #define dup(a)          __ast_fdleak_dup(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
71
72 #if defined(__cplusplus) || defined(c_plusplus)
73 extern "C" {
74 #endif
75 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...);
76 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func);
77 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func);
78 int __ast_fdleak_close(int fd);
79 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func);
80 int __ast_fdleak_fclose(FILE *ptr);
81 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func);
82 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func);
83 #if defined(__cplusplus) || defined(c_plusplus)
84 }
85 #endif
86 #endif
87
88 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
89 int ast_fd_init(void);                          /*!< Provided by astfd.c */
90 int ast_pbx_init(void);                         /*!< Provided by pbx.c */
91
92 /*!
93  * \brief Register a function to be executed before Asterisk exits.
94  * \param func The callback function to use.
95  *
96  * \retval 0 on success.
97  * \retval -1 on error.
98  *
99  * \note This function should be rarely used in situations where
100  * something must be shutdown to avoid corruption, excessive data
101  * loss, or when external programs must be stopped.  All other
102  * cleanup in the core should use ast_register_cleanup.
103  */
104 int ast_register_atexit(void (*func)(void));
105
106 /*!
107  * \since 11.9
108  * \brief Register a function to be executed before Asterisk gracefully exits.
109  *
110  * If Asterisk is immediately shutdown (core stop now, or sending the TERM
111  * signal), the callback is not run. When the callbacks are run, they are run in
112  * sequence with ast_register_atexit() callbacks, in the reverse order of
113  * registration.
114  *
115  * \param func The callback function to use.
116  *
117  * \retval 0 on success.
118  * \retval -1 on error.
119  */
120 int ast_register_cleanup(void (*func)(void));
121
122 /*!
123  * \brief Unregister a function registered with ast_register_atexit().
124  * \param func The callback function to unregister.
125  */
126 void ast_unregister_atexit(void (*func)(void));
127
128 /*!
129  * \brief Cancel an existing shutdown and return to normal operation.
130  *
131  * \note Shutdown can be cancelled while the server is waiting for
132  * any existing channels to be destroyed before shutdown becomes
133  * irreversible.
134  *
135  * \return non-zero if shutdown cancelled.
136  */
137 int ast_cancel_shutdown(void);
138
139 /*!
140  * \details
141  * The server is preventing new channel creation in preparation for
142  * shutdown and may actively be releasing resources.  The shutdown
143  * process may be canceled by ast_cancel_shutdown() if it is not too
144  * late.
145  *
146  * \note The preparation to shutdown phase can be quite lengthy
147  * if we are gracefully shutting down.  How long existing calls will
148  * last is not up to us.
149  *
150  * \return non-zero if the server is preparing to or actively shutting down.
151  */
152 int ast_shutting_down(void);
153
154 /*!
155  * \return non-zero if the server is actively shutting down.
156  * \since 13.3.0
157  *
158  * \details
159  * The server is releasing resources and unloading modules.
160  * It won't be long now.
161  */
162 int ast_shutdown_final(void);
163
164 #ifdef MTX_PROFILE
165 #define HAVE_MTX_PROFILE        /* used in lock.h */
166 #endif /* MTX_PROFILE */
167
168 /*!
169  * \brief support for event profiling
170  *
171  * (note, this must be documented a lot more)
172  * ast_add_profile allocates a generic 'counter' with a given name,
173  * which can be shown with the command 'core show profile &lt;name&gt;'
174  *
175  * The counter accumulates positive or negative values supplied by
176  * \see ast_add_profile(), dividing them by the 'scale' value passed in the
177  * create call, and also counts the number of 'events'.
178  * Values can also be taked by the TSC counter on ia32 architectures,
179  * in which case you can mark the start of an event calling ast_mark(id, 1)
180  * and then the end of the event with ast_mark(id, 0).
181  * For non-i386 architectures, these two calls return 0.
182  */
183 int ast_add_profile(const char *, uint64_t scale);
184 int64_t ast_profile(int, int64_t);
185 int64_t ast_mark(int, int start1_stop0);
186
187 /*! \brief
188  * Definition of various structures that many asterisk files need,
189  * but only because they need to know that the type exists.
190  *
191  */
192
193 struct ast_channel;
194 struct ast_frame;
195 struct ast_module;
196 struct ast_variable;
197 struct ast_str;
198 struct ast_sched_context;
199
200 /* Some handy macros for turning a preprocessor token into (effectively) a quoted string */
201 #define __stringify_1(x)        #x
202 #define __stringify(x)          __stringify_1(x)
203
204 #if defined(AST_IN_CORE) \
205         || (!defined(AST_MODULE_SELF_SYM) \
206                 && (defined(STANDALONE) || defined(STANDALONE2) || defined(AST_NOT_MODULE)))
207
208 #define AST_MODULE_SELF NULL
209
210 #elif defined(AST_MODULE_SELF_SYM)
211
212 /*! Retreive the 'struct ast_module *' for the current module. */
213 #define AST_MODULE_SELF AST_MODULE_SELF_SYM()
214
215 struct ast_module;
216 /* Internal/forward declaration, AST_MODULE_SELF should be used instead. */
217 struct ast_module *AST_MODULE_SELF_SYM(void);
218
219 #else
220
221 #error "Externally compiled modules must declare AST_MODULE_SELF_SYM."
222
223 #endif
224
225 /*!
226  * \brief Retrieve the PBX UUID
227  * \param pbx_uuid A buffer of at least AST_UUID_STR_LEN (36 + 1) size to receive the UUID
228  * \param length The buffer length
229  */
230 int ast_pbx_uuid_get(char *pbx_uuid, int length);
231
232 #endif /* _ASTERISK_H */