diff options
Diffstat (limited to 'include/asterisk.h')
| -rw-r--r-- | include/asterisk.h | 210 |
1 files changed, 210 insertions, 0 deletions
diff --git a/include/asterisk.h b/include/asterisk.h new file mode 100644 index 000000000..20f5aa9d4 --- /dev/null +++ b/include/asterisk.h @@ -0,0 +1,210 @@ +/* + * Asterisk -- A telephony toolkit for Linux. + * + * General Definitions for Asterisk top level program + * + * Copyright (C) 1999-2006, Digium, Inc. + * + * Mark Spencer <markster@digium.com> + * + * This program is free software, distributed under the terms of + * the GNU General Public License + */ + +/*! \file + * \brief Asterisk main include file. File version handling, generic pbx functions. + */ + +#ifndef _ASTERISK_H +#define _ASTERISK_H + +#include "asterisk/autoconfig.h" + +#if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE_AEL) && defined(MALLOC_DEBUG) +#include "asterisk/astmm.h" +#endif + +#include "asterisk/compat.h" + +#include "asterisk/paths.h" + +#define DEFAULT_LANGUAGE "en" + +#define DEFAULT_SAMPLE_RATE 8000 +#define DEFAULT_SAMPLES_PER_MS ((DEFAULT_SAMPLE_RATE)/1000) +#define setpriority __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__ +#define sched_setscheduler __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__ + +/* provided in asterisk.c */ +extern char ast_config_AST_CONFIG_DIR[PATH_MAX]; +extern char ast_config_AST_CONFIG_FILE[PATH_MAX]; +extern char ast_config_AST_MODULE_DIR[PATH_MAX]; +extern char ast_config_AST_SPOOL_DIR[PATH_MAX]; +extern char ast_config_AST_MONITOR_DIR[PATH_MAX]; +extern char ast_config_AST_VAR_DIR[PATH_MAX]; +extern char ast_config_AST_DATA_DIR[PATH_MAX]; +extern char ast_config_AST_LOG_DIR[PATH_MAX]; +extern char ast_config_AST_AGI_DIR[PATH_MAX]; +extern char ast_config_AST_DB[PATH_MAX]; +extern char ast_config_AST_KEY_DIR[PATH_MAX]; +extern char ast_config_AST_PID[PATH_MAX]; +extern char ast_config_AST_SOCKET[PATH_MAX]; +extern char ast_config_AST_RUN_DIR[PATH_MAX]; +extern char ast_config_AST_CTL_PERMISSIONS[PATH_MAX]; +extern char ast_config_AST_CTL_OWNER[PATH_MAX]; +extern char ast_config_AST_CTL_GROUP[PATH_MAX]; +extern char ast_config_AST_CTL[PATH_MAX]; +extern char ast_config_AST_SYSTEM_NAME[20]; + +int ast_set_priority(int); /*!< Provided by asterisk.c */ +int load_modules(unsigned int); /*!< Provided by loader.c */ +int load_pbx(void); /*!< Provided by pbx.c */ +int init_logger(void); /*!< Provided by logger.c */ +void close_logger(void); /*!< Provided by logger.c */ +int reload_logger(int); /*!< Provided by logger.c */ +int init_framer(void); /*!< Provided by frame.c */ +int ast_term_init(void); /*!< Provided by term.c */ +int astdb_init(void); /*!< Provided by db.c */ +void ast_channels_init(void); /*!< Provided by channel.c */ +void ast_builtins_init(void); /*!< Provided by cli.c */ +int dnsmgr_init(void); /*!< Provided by dnsmgr.c */ +void dnsmgr_start_refresh(void); /*!< Provided by dnsmgr.c */ +int dnsmgr_reload(void); /*!< Provided by dnsmgr.c */ +void threadstorage_init(void); /*!< Provided by threadstorage.c */ +int astobj2_init(void); /*! Provided by astobj2.c */ +void ast_autoservice_init(void); /*!< Provided by autoservice.c */ + +/* Many headers need 'ast_channel' to be defined */ +struct ast_channel; + +/* Many headers need 'ast_module' to be defined */ +struct ast_module; + +/*! + * \brief Reload asterisk modules. + * \param name the name of the module to reload + * + * This function reloads the specified module, or if no modules are specified, + * it will reload all loaded modules. + * + * \note Modules are reloaded using their reload() functions, not unloading + * them and loading them again. + * + * \return Zero if the specified module was not found, 1 if the module was + * found but cannot be reloaded, -1 if a reload operation is already in + * progress, and 2 if the specfied module was found and reloaded. + */ +int ast_module_reload(const char *name); + +/*! + * \brief Register a function to be executed before Asterisk exits. + * \param func The callback function to use. + * + * \return Zero on success, -1 on error. + */ +int ast_register_atexit(void (*func)(void)); + +/*! + * \brief Unregister a function registered with ast_register_atexit(). + * \param func The callback function to unregister. + */ +void ast_unregister_atexit(void (*func)(void)); + +#if !defined(LOW_MEMORY) +/*! + * \brief Register the version of a source code file with the core. + * \param file the source file name + * \param version the version string (typically a CVS revision keyword string) + * \return nothing + * + * This function should not be called directly, but instead the + * ASTERISK_FILE_VERSION macro should be used to register a file with the core. + */ +void ast_register_file_version(const char *file, const char *version); + +/*! + * \brief Unregister a source code file from the core. + * \param file the source file name + * \return nothing + * + * This function should not be called directly, but instead the + * ASTERISK_FILE_VERSION macro should be used to automatically unregister + * the file when the module is unloaded. + */ +void ast_unregister_file_version(const char *file); + +/*! + * \brief Register/unregister a source code file with the core. + * \param file the source file name + * \param version the version string (typically a CVS revision keyword string) + * + * This macro will place a file-scope constructor and destructor into the + * source of the module using it; this will cause the version of this file + * to registered with the Asterisk core (and unregistered) at the appropriate + * times. + * + * Example: + * + * \code + * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$") + * \endcode + * + * \note The dollar signs above have been protected with backslashes to keep + * CVS from modifying them in this file; under normal circumstances they would + * not be present and CVS would expand the Revision keyword into the file's + * revision number. + */ +#ifdef MTX_PROFILE +#define HAVE_MTX_PROFILE /* used in lock.h */ +#define ASTERISK_FILE_VERSION(file, version) \ + static int mtx_prof = -1; /* profile mutex */ \ + static void __attribute__((constructor)) __register_file_version(void) \ + { \ + mtx_prof = ast_add_profile("mtx_lock_" file, 0); \ + ast_register_file_version(file, version); \ + } \ + static void __attribute__((destructor)) __unregister_file_version(void) \ + { \ + ast_unregister_file_version(file); \ + } +#else /* !MTX_PROFILE */ +#define ASTERISK_FILE_VERSION(file, version) \ + static void __attribute__((constructor)) __register_file_version(void) \ + { \ + ast_register_file_version(file, version); \ + } \ + static void __attribute__((destructor)) __unregister_file_version(void) \ + { \ + ast_unregister_file_version(file); \ + } +#endif /* !MTX_PROFILE */ +#else /* LOW_MEMORY */ +#define ASTERISK_FILE_VERSION(file, x) +#endif /* LOW_MEMORY */ + +#if !defined(LOW_MEMORY) +/*! + * \brief support for event profiling + * + * (note, this must be documented a lot more) + * ast_add_profile allocates a generic 'counter' with a given name, + * which can be shown with the command 'show profile <name>' + * + * The counter accumulates positive or negative values supplied by + * ast_add_profile(), dividing them by the 'scale' value passed in the + * create call, and also counts the number of 'events'. + * Values can also be taked by the TSC counter on ia32 architectures, + * in which case you can mark the start of an event calling ast_mark(id, 1) + * and then the end of the event with ast_mark(id, 0). + * For non-i386 architectures, these two calls return 0. + */ +int ast_add_profile(const char *, uint64_t scale); +int64_t ast_profile(int, int64_t); +int64_t ast_mark(int, int start1_stop0); +#else /* LOW_MEMORY */ +#define ast_add_profile(a, b) 0 +#define ast_profile(a, b) do { } while (0) +#define ast_mark(a, b) do { } while (0) +#endif /* LOW_MEMORY */ + +#endif /* _ASTERISK_H */ |