Engine.halt
From Yate Documentation
(Difference between revisions)
(Created page with " '''engine.halt''' is a message sent by the engine to the modules that have a message handler registered for it and tells them that Yate is stopping and this is the last chanc...") |
|||
Line 1: | Line 1: | ||
− | '''engine.halt''' is a message sent by the engine to the modules that have a message handler registered for it | + | '''engine.halt''' is a message sent by the engine to the modules that have a message handler registered for it. |
+ | This message tells them that Yate is stopping and this is the last chance to clean up before Yate kills all module threads. | ||
− | This message has no parameters | + | ===Parameters=== |
+ | |||
+ | This message has no parameters. | ||
+ | |||
+ | ===Return=== | ||
+ | |||
+ | The message return value is ignored by the engine as it only serves as a means of shutdown notification towards the listening modules. | ||
+ | |||
+ | |||
+ | '''See also''' | ||
+ | |||
+ | * [[engine.init]] | ||
+ | * [[engine.busy]] | ||
+ | * [[engine.help]] | ||
+ | * [[engine.command]] | ||
+ | * [[engine.status]] | ||
+ | * [[engine.timer]] | ||
+ | * [[engine.cipher]] | ||
+ | * [[module.update]] |
Latest revision as of 13:26, 18 January 2013
engine.halt is a message sent by the engine to the modules that have a message handler registered for it. This message tells them that Yate is stopping and this is the last chance to clean up before Yate kills all module threads.
[edit] Parameters
This message has no parameters.
[edit] Return
The message return value is ignored by the engine as it only serves as a means of shutdown notification towards the listening modules.
See also