A lot of doxygen updates
[asterisk/asterisk.git] / include / asterisk / _private.h
1 /*
2  * Prototypes for public functions only of internal interest,
3  * normally not used by modules.
4  * What goes here are typically *_init() routines.
5  */
6
7 /*! \file
8  *
9  * \brief
10  * Prototypes for public functions only of internal interest,
11  * 
12  */
13
14
15 #ifndef _ASTERISK__PRIVATE_H
16 #define _ASTERISK__PRIVATE_H
17
18 int load_modules(unsigned int);         /*!< Provided by loader.c */
19 int load_pbx(void);                     /*!< Provided by pbx.c */
20 int init_logger(void);                  /*!< Provided by logger.c */
21 void close_logger(void);                /*!< Provided by logger.c */
22 int init_framer(void);                  /*!< Provided by frame.c */
23 int ast_term_init(void);                /*!< Provided by term.c */
24 int astdb_init(void);                   /*!< Provided by db.c */
25 void ast_channels_init(void);           /*!< Provided by channel.c */
26 void ast_builtins_init(void);           /*!< Provided by cli.c */
27 int dnsmgr_init(void);                  /*!< Provided by dnsmgr.c */ 
28 void dnsmgr_start_refresh(void);        /*!< Provided by dnsmgr.c */
29 int dnsmgr_reload(void);                /*!< Provided by dnsmgr.c */
30 void threadstorage_init(void);          /*!< Provided by threadstorage.c */
31 void ast_event_init(void);              /*!< Provided by event.c */
32 int ast_device_state_engine_init(void); /*!< Provided by devicestate.c */
33 int astobj2_init(void);                 /*!< Provided by astobj2.c */
34 int ast_file_init(void);                /*!< Provided by file.c */
35
36 /*!
37  * \brief Reload asterisk modules.
38  * \param name the name of the module to reload
39  *
40  * This function reloads the specified module, or if no modules are specified,
41  * it will reload all loaded modules.
42  *
43  * \note Modules are reloaded using their reload() functions, not unloading
44  * them and loading them again.
45  * 
46  * \return 0 if the specified module was not found.
47  * \retval 1 if the module was found but cannot be reloaded.
48  * \retval -1 if a reload operation is already in progress.
49  * \retval 2 if the specfied module was found and reloaded.
50  */
51 int ast_module_reload(const char *name);
52
53 #endif /* _ASTERISK__PRIVATE_H */