Mon Nov 24 15:34:08 2008

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

Generated on Mon Nov 24 15:34:08 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7