summaryrefslogtreecommitdiff
path: root/include/asterisk.h
diff options
context:
space:
mode:
authorCorey Farrell <git@cfware.com>2015-03-26 22:24:26 +0000
committerCorey Farrell <git@cfware.com>2015-03-26 22:24:26 +0000
commit3ddd92902af9eaa3018f7e25e430afcfe4322845 (patch)
tree1ab68bf8be8af553138e4b6019bd74f87f5f48c5 /include/asterisk.h
parentd7fc85e69d5dc23f27ec15dacaa03914ece64e42 (diff)
Replace most uses of ast_register_atexit with ast_register_cleanup.
Since 'core stop now' and 'core restart now' do not stop modules, it is unsafe for most of the core to run cleanups. Originally all cleanups used ast_register_atexit, and were only changed when it was shown to be unsafe. ast_register_atexit is now used only when absolutely required to prevent corruption and close child processes. Exceptions that need to use ast_register_atexit: * CDR: Flush records. * res_musiconhold: Kill external applications. * AstDB: Close the DB. * canary_exit: Kill canary process. ASTERISK-24142 #close Reported by: David Brillert ASTERISK-24683 #close Reported by: Peter Katzmann ASTERISK-24805 #close Reported by: Badalian Vyacheslav ASTERISK-24881 #close Reported by: Corey Farrell Review: https://reviewboard.asterisk.org/r/4500/ Review: https://reviewboard.asterisk.org/r/4501/ ........ Merged revisions 433495 from http://svn.asterisk.org/svn/asterisk/branches/11 ........ Merged revisions 433497 from http://svn.asterisk.org/svn/asterisk/branches/13 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@433498 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk.h')
-rw-r--r--include/asterisk.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/asterisk.h b/include/asterisk.h
index edb100b6b..9a0264e8c 100644
--- a/include/asterisk.h
+++ b/include/asterisk.h
@@ -86,6 +86,11 @@ int ast_pbx_init(void); /*!< Provided by pbx.c */
*
* \retval 0 on success.
* \retval -1 on error.
+ *
+ * \note This function should be rarely used in situations where
+ * something must be shutdown to avoid corruption, excessive data
+ * loss, or when external programs must be stopped. All other
+ * cleanup in the core should use ast_register_cleanup.
*/
int ast_register_atexit(void (*func)(void));