Sat Mar 10 01:54:46 2012

Asterisk developer's documentation


asterisk.h File Reference

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

#include "asterisk/autoconfig.h"
#include "asterisk/compat.h"

Go to the source code of this file.

Defines

#define AST_DIR_MODE   0777
#define AST_FILE_MODE   0666
#define ASTERISK_FILE_VERSION(file, version)
 Register/unregister a source code file with the core.
#define bcopy   0x__dont_use_bcopy__use_memmove_instead()
#define bzero   0x__dont_use_bzero__use_memset_instead""
#define DEFAULT_LANGUAGE   "en"
#define DEFAULT_SAMPLE_RATE   8000
#define DEFAULT_SAMPLES_PER_MS   ((DEFAULT_SAMPLE_RATE)/1000)
#define sched_setscheduler   __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
#define setpriority   __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__

Functions

int ast_add_profile (const char *, uint64_t scale)
 support for event profiling
char * ast_complete_source_filename (const char *partial, int n)
int ast_fd_init (void)
const char * ast_file_version_find (const char *file)
 Find version for given module name.
int64_t ast_mark (int, int start1_stop0)
int ast_pbx_init (void)
int64_t ast_profile (int, int64_t)
int ast_register_atexit (void(*func)(void))
 Register a function to be executed before Asterisk exits.
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)
 We set ourselves to a high priority, that we might pre-empt everything else. If your PBX has heavy activity on it, this is a good thing.
void ast_unregister_atexit (void(*func)(void))
 Unregister a function registered with ast_register_atexit().
void ast_unregister_file_version (const char *file)
 Unregister a source code file from the core.


Detailed Description

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

Definition in file asterisk.h.


Define Documentation

#define AST_DIR_MODE   0777

Definition at line 33 of file asterisk.h.

#define AST_FILE_MODE   0666

Definition at line 36 of file asterisk.h.

Referenced by __ast_play_and_record(), action_createconfig(), ast_lock_path_lockfile(), ast_monitor_start(), chanspy_exec(), copy(), dbinit(), dictate_exec(), extenspy_exec(), festival_exec(), handle_cli_file_convert(), handle_pri_set_debug_file(), handle_recordfile(), load_module(), recordthread(), sms_log(), and try_firmware().

#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 SVN 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 164 of file asterisk.h.

#define bcopy   0x__dont_use_bcopy__use_memmove_instead()

Definition at line 224 of file asterisk.h.

#define bzero   0x__dont_use_bzero__use_memset_instead""

Definition at line 223 of file asterisk.h.

#define DEFAULT_LANGUAGE   "en"

Definition at line 39 of file asterisk.h.

Referenced by fileexists_core().

#define DEFAULT_SAMPLE_RATE   8000

Definition at line 41 of file asterisk.h.

Referenced by check_header(), ogg_vorbis_rewrite(), setformat(), and write_header().

#define DEFAULT_SAMPLES_PER_MS   ((DEFAULT_SAMPLE_RATE)/1000)

Definition at line 42 of file asterisk.h.

Referenced by ast_stream_fastforward(), ast_stream_rewind(), and isAnsweringMachine().

#define sched_setscheduler   __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__

Definition at line 44 of file asterisk.h.

Referenced by ast_set_priority().

#define setpriority   __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__

Definition at line 43 of file asterisk.h.

Referenced by ast_set_priority().


Function Documentation

int ast_add_profile ( const char *  name,
uint64_t  scale 
)

support for event profiling

Returns:
Returns the identifier of the counter.

Definition at line 700 of file asterisk.c.

References ast_calloc, ast_realloc, ast_strdup, profile_data::e, profile_data::entries, profile_entry::events, profile_entry::mark, profile_data::max_size, profile_entry::name, prof_data, profile_entry::scale, and profile_entry::value.

Referenced by extension_match_core().

00701 {
00702    int l = sizeof(struct profile_data);
00703    int n = 10; /* default entries */
00704 
00705    if (prof_data == NULL) {
00706       prof_data = ast_calloc(1, l + n*sizeof(struct profile_entry));
00707       if (prof_data == NULL)
00708          return -1;
00709       prof_data->entries = 0;
00710       prof_data->max_size = n;
00711    }
00712    if (prof_data->entries >= prof_data->max_size) {
00713       void *p;
00714       n = prof_data->max_size + 20;
00715       p = ast_realloc(prof_data, l + n*sizeof(struct profile_entry));
00716       if (p == NULL)
00717          return -1;
00718       prof_data = p;
00719       prof_data->max_size = n;
00720    }
00721    n = prof_data->entries++;
00722    prof_data->e[n].name = ast_strdup(name);
00723    prof_data->e[n].value = 0;
00724    prof_data->e[n].events = 0;
00725    prof_data->e[n].mark = 0;
00726    prof_data->e[n].scale = scale;
00727    return n;
00728 }

char* ast_complete_source_filename ( const char *  partial,
int  n 
)

Definition at line 351 of file asterisk.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, file_version::file, len(), and ast_atexit::list.

Referenced by handle_verbose().

00352 {
00353    struct file_version *find;
00354    size_t len = strlen(partial);
00355    int count = 0;
00356    char *res = NULL;
00357 
00358    AST_RWLIST_RDLOCK(&file_versions);
00359    AST_RWLIST_TRAVERSE(&file_versions, find, list) {
00360       if (!strncasecmp(find->file, partial, len) && ++count > n) {
00361          res = ast_strdup(find->file);
00362          break;
00363       }
00364    }
00365    AST_RWLIST_UNLOCK(&file_versions);
00366    return res;
00367 }

int ast_fd_init ( void   ) 

Provided by astfd.c

Definition at line 275 of file astfd.c.

Referenced by main().

00276 {
00277    return 0;
00278 }

const char* ast_file_version_find ( const char *  file  ) 

Find version for given module name.

Parameters:
file Module name (i.e. chan_sip.so)
Returns:
version string or NULL if the module is not found

Definition at line 370 of file asterisk.c.

References AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, file_version::file, ast_atexit::list, and file_version::version.

Referenced by manager_modulecheck().

00371 {
00372    struct file_version *iterator;
00373 
00374    AST_RWLIST_WRLOCK(&file_versions);
00375    AST_RWLIST_TRAVERSE(&file_versions, iterator, list) {
00376       if (!strcasecmp(iterator->file, file))
00377          break;
00378    }
00379    AST_RWLIST_UNLOCK(&file_versions);
00380    if (iterator)
00381       return iterator->version;
00382    return NULL;
00383 }      

int64_t ast_mark ( int  ,
int  start1_stop0 
)

Definition at line 765 of file asterisk.c.

References profile_data::e, profile_data::entries, profile_entry::events, profile_entry::mark, prof_data, rdtsc(), profile_entry::scale, and profile_entry::value.

Referenced by __ast_pthread_mutex_lock(), and extension_match_core().

00766 {
00767    if (!prof_data || i < 0 || i > prof_data->entries) /* invalid index */
00768       return 0;
00769    if (startstop == 1)
00770       prof_data->e[i].mark = rdtsc();
00771    else {
00772       prof_data->e[i].mark = (rdtsc() - prof_data->e[i].mark);
00773       if (prof_data->e[i].scale > 1)
00774          prof_data->e[i].mark /= prof_data->e[i].scale;
00775       prof_data->e[i].value += prof_data->e[i].mark;
00776       prof_data->e[i].events++;
00777    }
00778    return prof_data->e[i].mark;
00779 }

int ast_pbx_init ( void   ) 

Provided by pbx.c

Definition at line 10672 of file pbx.c.

References ao2_container_alloc, HASH_EXTENHINT_SIZE, hint_cmp(), hint_hash(), hints, statecbs, and statecbs_cmp().

Referenced by main().

10673 {
10674    hints = ao2_container_alloc(HASH_EXTENHINT_SIZE, hint_hash, hint_cmp);
10675    statecbs = ao2_container_alloc(1, NULL, statecbs_cmp);
10676 
10677    return (hints && statecbs) ? 0 : -1;
10678 }

int64_t ast_profile ( int  ,
int64_t   
)

Definition at line 730 of file asterisk.c.

References profile_data::e, profile_data::entries, profile_entry::events, prof_data, profile_entry::scale, and profile_entry::value.

00731 {
00732    if (!prof_data || i < 0 || i > prof_data->entries) /* invalid index */
00733       return 0;
00734    if (prof_data->e[i].scale > 1)
00735       delta /= prof_data->e[i].scale;
00736    prof_data->e[i].value += delta;
00737    prof_data->e[i].events++;
00738    return prof_data->e[i].value;
00739 }

int ast_register_atexit ( void(*)(void)  func  ) 

Register a function to be executed before Asterisk exits.

Parameters:
func The callback function to use.
Return values:
0 on success.
-1 on error.

Definition at line 941 of file asterisk.c.

References ast_calloc, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_unregister_atexit(), and ast_atexit::list.

Referenced by ast_cel_engine_init(), do_reload(), load_module(), and main().

00942 {
00943    struct ast_atexit *ae;
00944 
00945    if (!(ae = ast_calloc(1, sizeof(*ae))))
00946       return -1;
00947 
00948    ae->func = func;
00949 
00950    ast_unregister_atexit(func);  
00951 
00952    AST_RWLIST_WRLOCK(&atexits);
00953    AST_RWLIST_INSERT_HEAD(&atexits, ae, list);
00954    AST_RWLIST_UNLOCK(&atexits);
00955 
00956    return 0;
00957 }

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 SVN 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.

Definition at line 312 of file asterisk.c.

References ast_calloc, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strdupa, ast_strip(), ast_strip_quoted(), and ast_atexit::list.

00313 {
00314    struct file_version *new;
00315    char *work;
00316    size_t version_length;
00317 
00318    work = ast_strdupa(version);
00319    work = ast_strip(ast_strip_quoted(work, "$", "$"));
00320    version_length = strlen(work) + 1;
00321    
00322    if (!(new = ast_calloc(1, sizeof(*new) + version_length)))
00323       return;
00324 
00325    new->file = file;
00326    new->version = (char *) new + sizeof(*new);
00327    memcpy(new->version, work, version_length);
00328    AST_RWLIST_WRLOCK(&file_versions);
00329    AST_RWLIST_INSERT_HEAD(&file_versions, new, list);
00330    AST_RWLIST_UNLOCK(&file_versions);
00331 }

int ast_set_priority ( int   ) 

We set ourselves to a high priority, that we might pre-empt everything else. If your PBX has heavy activity on it, this is a good thing.

Provided by asterisk.c

Definition at line 1574 of file asterisk.c.

References ast_log(), ast_verbose, LOG_WARNING, sched_setscheduler, and setpriority.

Referenced by ast_safe_system(), canary_thread(), icesencode(), launch_script(), main(), mp3play(), NBScatplay(), send_waveform_to_fd(), spawn_mp3(), and spawn_ras().

01575 {
01576    struct sched_param sched;
01577    memset(&sched, 0, sizeof(sched));
01578 #ifdef __linux__
01579    if (pri) {  
01580       sched.sched_priority = 10;
01581       if (sched_setscheduler(0, SCHED_RR, &sched)) {
01582          ast_log(LOG_WARNING, "Unable to set high priority\n");
01583          return -1;
01584       } else
01585          if (option_verbose)
01586             ast_verbose("Set to realtime thread\n");
01587    } else {
01588       sched.sched_priority = 0;
01589       /* According to the manpage, these parameters can never fail. */
01590       sched_setscheduler(0, SCHED_OTHER, &sched);
01591    }
01592 #else
01593    if (pri) {
01594       if (setpriority(PRIO_PROCESS, 0, -10) == -1) {
01595          ast_log(LOG_WARNING, "Unable to set high priority\n");
01596          return -1;
01597       } else
01598          if (option_verbose)
01599             ast_verbose("Set to high priority\n");
01600    } else {
01601       /* According to the manpage, these parameters can never fail. */
01602       setpriority(PRIO_PROCESS, 0, 0);
01603    }
01604 #endif
01605    return 0;
01606 }

void ast_unregister_atexit ( void(*)(void)  func  ) 

Unregister a function registered with ast_register_atexit().

Parameters:
func The callback function to unregister.

Definition at line 959 of file asterisk.c.

References AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, free, ast_atexit::func, and ast_atexit::list.

Referenced by ast_register_atexit(), do_reload(), and unload_module().

00960 {
00961    struct ast_atexit *ae = NULL;
00962 
00963    AST_RWLIST_WRLOCK(&atexits);
00964    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&atexits, ae, list) {
00965       if (ae->func == func) {
00966          AST_RWLIST_REMOVE_CURRENT(list);
00967          break;
00968       }
00969    }
00970    AST_RWLIST_TRAVERSE_SAFE_END;
00971    AST_RWLIST_UNLOCK(&atexits);
00972 
00973    free(ae);
00974 }

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.

Definition at line 333 of file asterisk.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, file_version::file, and ast_atexit::list.

00334 {
00335    struct file_version *find;
00336 
00337    AST_RWLIST_WRLOCK(&file_versions);
00338    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&file_versions, find, list) {
00339       if (!strcasecmp(find->file, file)) {
00340          AST_RWLIST_REMOVE_CURRENT(list);
00341          break;
00342       }
00343    }
00344    AST_RWLIST_TRAVERSE_SAFE_END;
00345    AST_RWLIST_UNLOCK(&file_versions);
00346 
00347    if (find)
00348       ast_free(find);
00349 }


Generated on Sat Mar 10 01:54:46 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7