Sat Apr 26 20:55:02 2008

Asterisk developer's documentation

---

asterisk.h File Reference

Asterisk main include file. File version handling, generic pbx functions. More...

Go to the source code of this file.

Defines
#define	AST_CONFIG_MAX_PATH   255
#define	ASTERISK_FILE_VERSION(file, version)
	Register/unregister a source code file with the core.
#define	DEFAULT_LANGUAGE   "en"
Functions
void	ast_channels_init (void)
void	ast_register_file_version (const char *file, const char *version)
	Register the version of a source code file with the core.
int	ast_set_priority (int)
void	ast_unregister_file_version (const char *file)
	Unregister a source code file from the core.
int	astdb_init (void)
void	close_logger (void)
int	dnsmgr_init (void)
void	dnsmgr_reload (void)
void	dnsmgr_start_refresh (void)
int	init_framer (void)
int	init_logger (void)
int	load_modules (const int preload_only)
int	load_pbx (void)
int	reload_logger (int)
int	term_init (void)
Variables
char	ast_config_AST_AGI_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_CONFIG_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_CONFIG_FILE [AST_CONFIG_MAX_PATH]
char	ast_config_AST_CTL [AST_CONFIG_MAX_PATH]
char	ast_config_AST_CTL_GROUP [AST_CONFIG_MAX_PATH]
char	ast_config_AST_CTL_OWNER [AST_CONFIG_MAX_PATH]
char	ast_config_AST_CTL_PERMISSIONS [AST_CONFIG_MAX_PATH]
char	ast_config_AST_DATA_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_DB [AST_CONFIG_MAX_PATH]
char	ast_config_AST_KEY_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_LOG_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_MODULE_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_MONITOR_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_PID [AST_CONFIG_MAX_PATH]
char	ast_config_AST_RUN_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_SOCKET [AST_CONFIG_MAX_PATH]
char	ast_config_AST_SPOOL_DIR [AST_CONFIG_MAX_PATH]
char	ast_config_AST_VAR_DIR [AST_CONFIG_MAX_PATH]

---

Detailed Description

Asterisk main include file. File version handling, generic pbx functions.

Definition in file asterisk.h.

---

Define Documentation

#define ASTERISK_FILE_VERSION	(	file,
		version		)

Register/unregister a source code file with the core.

Parameters:

	file	the source file name
	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:

 ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")

Note:

The dollar signs above have been protected with backslashes to keep SVN from modifying them in this file; under normal circumstances they would not be present and SVN would expand the Revision keyword into the file's revision number.

Definition at line 113 of file asterisk.h.

---

Function Documentation

void ast_register_file_version	(	const char *	file,
		const char *	version
	)

Register the version of a source code file with the core.

Parameters:

	file	the source file name
	version	the version string (typically a CVS revision keyword string)

Returns:

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_unregister_file_version

(

const char *

file

)

Unregister a source code file from the core.

Parameters:

file

the source file name

Returns:

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.

---