Wed Mar 4 19:58:01 2009

Asterisk developer's documentation


asterisk.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- A telephony toolkit for Linux.
00003  *
00004  * General Definitions for Asterisk top level program
00005  * 
00006  * Copyright (C) 1999-2006, Digium, Inc.
00007  *
00008  * Mark Spencer <markster@digium.com>
00009  *
00010  * This program is free software, distributed under the terms of
00011  * the GNU General Public License
00012  */
00013 
00014 /*! \file
00015  * \brief Asterisk main include file. File version handling, generic pbx functions.
00016  */
00017 
00018 #ifndef _ASTERISK_H
00019 #define _ASTERISK_H
00020 
00021 #include "asterisk/autoconfig.h"
00022 
00023 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE_AEL) && defined(MALLOC_DEBUG)
00024 #include "asterisk/astmm.h"
00025 #endif
00026 
00027 #include "asterisk/compat.h"
00028 
00029 #include "asterisk/paths.h"
00030 
00031 #define DEFAULT_LANGUAGE "en"
00032 
00033 #define DEFAULT_SAMPLE_RATE 8000
00034 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
00035 #define  setpriority __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
00036 #define  sched_setscheduler   __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
00037 
00038 /* provided in asterisk.c */
00039 extern char ast_config_AST_CONFIG_DIR[PATH_MAX];
00040 extern char ast_config_AST_CONFIG_FILE[PATH_MAX];
00041 extern char ast_config_AST_MODULE_DIR[PATH_MAX];
00042 extern char ast_config_AST_SPOOL_DIR[PATH_MAX];
00043 extern char ast_config_AST_MONITOR_DIR[PATH_MAX];
00044 extern char ast_config_AST_VAR_DIR[PATH_MAX];
00045 extern char ast_config_AST_DATA_DIR[PATH_MAX];
00046 extern char ast_config_AST_LOG_DIR[PATH_MAX];
00047 extern char ast_config_AST_AGI_DIR[PATH_MAX];
00048 extern char ast_config_AST_DB[PATH_MAX];
00049 extern char ast_config_AST_KEY_DIR[PATH_MAX];
00050 extern char ast_config_AST_PID[PATH_MAX];
00051 extern char ast_config_AST_SOCKET[PATH_MAX];
00052 extern char ast_config_AST_RUN_DIR[PATH_MAX];
00053 extern char ast_config_AST_RUN_USER[PATH_MAX];
00054 extern char ast_config_AST_RUN_GROUP[PATH_MAX];
00055 extern char ast_config_AST_CTL_PERMISSIONS[PATH_MAX];
00056 extern char ast_config_AST_CTL_OWNER[PATH_MAX];
00057 extern char ast_config_AST_CTL_GROUP[PATH_MAX];
00058 extern char ast_config_AST_CTL[PATH_MAX];
00059 extern char ast_config_AST_SYSTEM_NAME[20];
00060 
00061 int ast_set_priority(int);       /*!< Provided by asterisk.c */
00062 int load_modules(unsigned int);        /*!< Provided by loader.c */
00063 int load_pbx(void);           /*!< Provided by pbx.c */
00064 int init_logger(void);           /*!< Provided by logger.c */
00065 void close_logger(void);         /*!< Provided by logger.c */
00066 int reload_logger(int);          /*!< Provided by logger.c */
00067 int init_framer(void);           /*!< Provided by frame.c */
00068 int ast_term_init(void);         /*!< Provided by term.c */
00069 int astdb_init(void);            /*!< Provided by db.c */
00070 void ast_channels_init(void);       /*!< Provided by channel.c */
00071 void ast_builtins_init(void);       /*!< Provided by cli.c */
00072 int dnsmgr_init(void);           /*!< Provided by dnsmgr.c */ 
00073 void dnsmgr_start_refresh(void);    /*!< Provided by dnsmgr.c */
00074 int dnsmgr_reload(void);         /*!< Provided by dnsmgr.c */
00075 void threadstorage_init(void);         /*!< Provided by threadstorage.c */
00076 int astobj2_init(void);          /*! Provided by astobj2.c */
00077 void ast_autoservice_init(void);    /*!< Provided by autoservice.c */
00078 
00079 /* Many headers need 'ast_channel' to be defined */
00080 struct ast_channel;
00081 
00082 /* Many headers need 'ast_module' to be defined */
00083 struct ast_module;
00084 
00085 /*!
00086  * \brief Reload asterisk modules.
00087  * \param name the name of the module to reload
00088  *
00089  * This function reloads the specified module, or if no modules are specified,
00090  * it will reload all loaded modules.
00091  *
00092  * \note Modules are reloaded using their reload() functions, not unloading
00093  * them and loading them again.
00094  * 
00095  * \return Zero if the specified module was not found, 1 if the module was
00096  * found but cannot be reloaded, -1 if a reload operation is already in
00097  * progress, and 2 if the specfied module was found and reloaded.
00098  */
00099 int ast_module_reload(const char *name);
00100 
00101 /*!
00102  * \brief Register a function to be executed before Asterisk exits.
00103  * \param func The callback function to use.
00104  *
00105  * \return Zero on success, -1 on error.
00106  */
00107 int ast_register_atexit(void (*func)(void));
00108 
00109 /*!   
00110  * \brief Unregister a function registered with ast_register_atexit().
00111  * \param func The callback function to unregister.   
00112  */
00113 void ast_unregister_atexit(void (*func)(void));
00114 
00115 #if !defined(LOW_MEMORY)
00116 /*!
00117  * \brief Register the version of a source code file with the core.
00118  * \param file the source file name
00119  * \param version the version string (typically a CVS revision keyword string)
00120  * \return nothing
00121  *
00122  * This function should not be called directly, but instead the
00123  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
00124  */
00125 void ast_register_file_version(const char *file, const char *version);
00126 
00127 /*!
00128  * \brief Unregister a source code file from the core.
00129  * \param file the source file name
00130  * \return nothing
00131  *
00132  * This function should not be called directly, but instead the
00133  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
00134  * the file when the module is unloaded.
00135  */
00136 void ast_unregister_file_version(const char *file);
00137 
00138 /*!
00139  * \brief Register/unregister a source code file with the core.
00140  * \param file the source file name
00141  * \param version the version string (typically a CVS revision keyword string)
00142  *
00143  * This macro will place a file-scope constructor and destructor into the
00144  * source of the module using it; this will cause the version of this file
00145  * to registered with the Asterisk core (and unregistered) at the appropriate
00146  * times.
00147  *
00148  * Example:
00149  *
00150  * \code
00151  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
00152  * \endcode
00153  *
00154  * \note The dollar signs above have been protected with backslashes to keep
00155  * CVS from modifying them in this file; under normal circumstances they would
00156  * not be present and CVS would expand the Revision keyword into the file's
00157  * revision number.
00158  */
00159 #ifdef MTX_PROFILE
00160 #define  HAVE_MTX_PROFILE  /* used in lock.h */
00161 #define ASTERISK_FILE_VERSION(file, version) \
00162    static int mtx_prof = -1;       /* profile mutex */   \
00163    static void __attribute__((constructor)) __register_file_version(void) \
00164    { \
00165       mtx_prof = ast_add_profile("mtx_lock_" file, 0);   \
00166       ast_register_file_version(file, version); \
00167    } \
00168    static void __attribute__((destructor)) __unregister_file_version(void) \
00169    { \
00170       ast_unregister_file_version(file); \
00171    }
00172 #else /* !MTX_PROFILE */
00173 #define ASTERISK_FILE_VERSION(file, version) \
00174    static void __attribute__((constructor)) __register_file_version(void) \
00175    { \
00176       ast_register_file_version(file, version); \
00177    } \
00178    static void __attribute__((destructor)) __unregister_file_version(void) \
00179    { \
00180       ast_unregister_file_version(file); \
00181    }
00182 #endif /* !MTX_PROFILE */
00183 #else /* LOW_MEMORY */
00184 #define ASTERISK_FILE_VERSION(file, x)
00185 #endif /* LOW_MEMORY */
00186 
00187 #if !defined(LOW_MEMORY)
00188 /*!
00189  * \brief support for event profiling
00190  *
00191  * (note, this must be documented a lot more)
00192  * ast_add_profile allocates a generic 'counter' with a given name,
00193  * which can be shown with the command 'show profile <name>'
00194  *
00195  * The counter accumulates positive or negative values supplied by
00196  * ast_add_profile(), dividing them by the 'scale' value passed in the
00197  * create call, and also counts the number of 'events'.
00198  * Values can also be taked by the TSC counter on ia32 architectures,
00199  * in which case you can mark the start of an event calling ast_mark(id, 1)
00200  * and then the end of the event with ast_mark(id, 0).
00201  * For non-i386 architectures, these two calls return 0.
00202  */
00203 int ast_add_profile(const char *, uint64_t scale);
00204 int64_t ast_profile(int, int64_t);
00205 int64_t ast_mark(int, int start1_stop0);
00206 #else /* LOW_MEMORY */
00207 #define ast_add_profile(a, b) 0
00208 #define ast_profile(a, b) do { } while (0)
00209 #define ast_mark(a, b) do { } while (0)
00210 #endif /* LOW_MEMORY */
00211 
00212 #endif /* _ASTERISK_H */

Generated on Wed Mar 4 19:58:01 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7