<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0cm;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri",sans-serif;
mso-fareast-language:EN-US;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:#0563C1;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:#954F72;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-family:"Calibri",sans-serif;
mso-fareast-language:EN-US;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-AU" link="#0563C1" vlink="#954F72">
<div class="WordSection1">
<p class="MsoNormal">To FreeSWITCH Users,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">See below for a sample template for a Lua Service Script running inside FreeSWITCH.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">The issue I have is fairly straightforward.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">I need a function to run when hangup is detected (ie. at the end of the call) however I understand this must not delay ending the script. This function is CleanUp(). Then I would like the service to end.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">The problem I am having is if the caller hangs up during the playback of “intro.wav” (as shown inside the MainService() function below), then the code jumps to the myHangupHook which calls CleanUp() perfectly, the issue is once CleanUp()
is complete I would like the Lua script to end there and then (ie. at the bottom of CleanUp()). What actually happens is it returns to MainService() and continues to try and play “info.wav”, unless I either check for session:ready() everywhere or add a goto
as shown below under each streamFile() function call.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">My aim is to reduce extra code and to make the Lua script simpler and easier to read. Also I would like to try and avoid goto statements, which I know can be done with if (session:ready()) etc….<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">So is there a way to stop a Lua script running inside FreeSWITCH cleanly? I have tried the os.exit() this is barred from use by FreeSWITCH. I have also tried session:destroy() which crashes FreeSWITCH (version 1.6.5 on CentOS 6.7, CentOS
7 and windows) 100% of the time!<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">I could look further into the Lua additions done by the FreeSWITCH team in the source code, however if someone has already solved this then that would be the best solution.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">FYI: Obviously the script below is simple, however I am sure that you understand if the script was complicated having to use “<b>if (session:ready()) then ….”</b> or “<b>if (not session:ready()) then goto HANGUPEXIT end”</b> makes the code
ugly.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Thanks in advance,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Andrew Keil<o:p></o:p></p>
<p class="MsoNormal"><b>Visytel Pty Ltd<o:p></o:p></b></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">------------------------------------------------------------------------------ Sample Lua Service -----------------------------------------------------------------------<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">-- Lua template for FreeSWITCH service<o:p></o:p></p>
<p class="MsoNormal">-- By: Andrew Keil (Visytel Pty Ltd)<o:p></o:p></p>
<p class="MsoNormal">-- Email: support@visytel.com <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">-- Setup script wide variables here<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">function PreAnswer()<o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "PRE ANSWER SECTION\n");<o:p></o:p></p>
<p class="MsoNormal"> -- Add your pre answer code from here<o:p></o:p></p>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"> -- End of your pre answer code<o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "PRE ANSWER SECTION COMPLETE\n");
<o:p></o:p></p>
<p class="MsoNormal">end <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">function AnswerCaller()<o:p></o:p></p>
<p class="MsoNormal"> session:answer()<o:p></o:p></p>
<p class="MsoNormal"> session:sleep(1000)<o:p></o:p></p>
<p class="MsoNormal">end <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">function MainService()<o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "MAIN SERVICE SECTION\n");
<o:p></o:p></p>
<p class="MsoNormal"> if (session:ready()) then<o:p></o:p></p>
<p class="MsoNormal"> -- Note (1): If you wish to end the call then simply use: goto ENDSERVICE<o:p></o:p></p>
<p class="MsoNormal"> -- Note (2): To terminate the service sooner when HANGUP is detected use: if (not session:ready()) then goto HANGUPEXIT end<o:p></o:p></p>
<p class="MsoNormal"> -- Add your main service code from here (caller would have been answered)<o:p></o:p></p>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"> session:streamFile("intro.wav")<o:p></o:p></p>
<p class="MsoNormal"> if (not session:ready()) then goto HANGUPEXIT end<o:p></o:p></p>
<p class="MsoNormal"> session:streamFile("info.wav")<o:p></o:p></p>
<p class="MsoNormal"> if (not session:ready()) then goto HANGUPEXIT end<o:p></o:p></p>
<p class="MsoNormal"> session:streamFile("outro.wav")
<o:p></o:p></p>
<p class="MsoNormal"> if (not session:ready()) then goto HANGUPEXIT end<o:p></o:p></p>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"> -- End of your main service code
<o:p></o:p></p>
<p class="MsoNormal"> end<o:p></o:p></p>
<p class="MsoNormal"> ::ENDSERVICE::<o:p></o:p></p>
<p class="MsoNormal"> if (session:ready()) then<o:p></o:p></p>
<p class="MsoNormal"> -- End of service so hangup<o:p></o:p></p>
<p class="MsoNormal"> session:hangup() -- Should automatically jump to CleanUp() via hangup handler if caller still online at this stage<o:p></o:p></p>
<p class="MsoNormal"> end<o:p></o:p></p>
<p class="MsoNormal"> goto END<o:p></o:p></p>
<p class="MsoNormal"> ::HANGUPEXIT::<o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "END OF SERVICE (HANGUP DETECTED)\n");
<o:p></o:p></p>
<p class="MsoNormal"> ::END:: <o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "MAIN SERVICE SECTION COMPLETE\n");
<o:p></o:p></p>
<p class="MsoNormal">end<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">function CleanUp()<o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "CLEANUP SECTION\n");
<o:p></o:p></p>
<p class="MsoNormal"> -- Add your cleanup code from here (caller would have been disconnected)<o:p></o:p></p>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"> -- End of your cleanup code<o:p></o:p></p>
<p class="MsoNormal"> freeswitch.consoleLog("INFO", "CLEANUP SECTION COMPLETE\n");
<o:p></o:p></p>
<p class="MsoNormal">end <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">function myHangupHook(s, status, arg)<o:p></o:p></p>
<p class="MsoNormal"> session:hangup()<o:p></o:p></p>
<p class="MsoNormal"> CleanUp() -- Run CleanUp function now since the caller has disconnected<o:p></o:p></p>
<p class="MsoNormal">end<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">-- Setup Hangup event handler here<o:p></o:p></p>
<p class="MsoNormal">v_hangup = "HANGUP"<o:p></o:p></p>
<p class="MsoNormal">session:setHangupHook("myHangupHook", "v_hangup")<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">-- Call service functions in order<o:p></o:p></p>
<p class="MsoNormal">PreAnswer()<o:p></o:p></p>
<p class="MsoNormal">AnswerCaller()<o:p></o:p></p>
<p class="MsoNormal">MainService()<o:p></o:p></p>
<p class="MsoNormal">-- End of Lua service<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
</body>
</html>