<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Yate: yatepbx.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <h1>yatepbx.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * yatepbx.h</span> <a name="l00003"></a>00003 <span class="comment"> * This file is part of the YATE Project http://YATE.null.ro</span> <a name="l00004"></a>00004 <span class="comment"> *</span> <a name="l00005"></a>00005 <span class="comment"> * Common C++ base classes for PBX related plugins</span> <a name="l00006"></a>00006 <span class="comment"> *</span> <a name="l00007"></a>00007 <span class="comment"> * Yet Another Telephony Engine - a fully featured software PBX and IVR</span> <a name="l00008"></a>00008 <span class="comment"> * Copyright (C) 2004-2006 Null Team</span> <a name="l00009"></a>00009 <span class="comment"> *</span> <a name="l00010"></a>00010 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span> <a name="l00011"></a>00011 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> <a name="l00012"></a>00012 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span> <a name="l00013"></a>00013 <span class="comment"> * (at your option) any later version.</span> <a name="l00014"></a>00014 <span class="comment"> *</span> <a name="l00015"></a>00015 <span class="comment"> * This program is distributed in the hope that it will be useful,</span> <a name="l00016"></a>00016 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00017"></a>00017 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00018"></a>00018 <span class="comment"> * GNU General Public License for more details.</span> <a name="l00019"></a>00019 <span class="comment"> *</span> <a name="l00020"></a>00020 <span class="comment"> * You should have received a copy of the GNU General Public License</span> <a name="l00021"></a>00021 <span class="comment"> * along with this program; if not, write to the Free Software</span> <a name="l00022"></a>00022 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.</span> <a name="l00023"></a>00023 <span class="comment"> */</span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#include <yatephone.h></span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="preprocessor">#ifdef _WINDOWS</span> <a name="l00028"></a>00028 <span class="preprocessor"></span> <a name="l00029"></a>00029 <span class="preprocessor">#ifdef LIBYPBX_EXPORTS</span> <a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define YPBX_API __declspec(dllexport)</span> <a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#else</span> <a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#ifndef LIBYPBX_STATIC</span> <a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define YPBX_API __declspec(dllimport)</span> <a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00036"></a>00036 <span class="preprocessor"></span> <a name="l00037"></a>00037 <span class="preprocessor">#endif </span><span class="comment">/* _WINDOWS */</span> <a name="l00038"></a>00038 <a name="l00039"></a>00039 <span class="preprocessor">#ifndef YPBX_API</span> <a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define YPBX_API</span> <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00042"></a>00042 <span class="preprocessor"></span> <a name="l00043"></a>00043 <span class="keyword">namespace </span>TelEngine { <a name="l00044"></a>00044 <a name="l00048"></a><a class="code" href="classTelEngine_1_1CallInfo.html">00048</a> <span class="keyword">class </span>YPBX_API <a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a> : <span class="keyword">public</span> <a class="code" href="classTelEngine_1_1NamedList.html" title="A named string container class.">NamedList</a> <a name="l00049"></a>00049 { <a name="l00050"></a>00050 <span class="keyword">public</span>: <a name="l00051"></a>00051 <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="classTelEngine_1_1CallEndpoint.html" title="An abstract call endpoint.">CallEndpoint</a>* call = 0) <a name="l00052"></a>00052 : <a class="code" href="classTelEngine_1_1NamedList.html" title="A named string container class.">NamedList</a>(name), m_call(call) <a name="l00053"></a>00053 { } <a name="l00054"></a>00054 <a name="l00055"></a>00055 <span class="keyword">virtual</span> ~<a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a>() <a name="l00056"></a>00056 { m_call = 0; } <a name="l00057"></a>00057 <a name="l00058"></a>00058 <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1CallEndpoint.html" title="An abstract call endpoint.">CallEndpoint</a>* call()<span class="keyword"> const</span> <a name="l00059"></a>00059 <span class="keyword"> </span>{ <span class="keywordflow">return</span> m_call; } <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="keyword">inline</span> <span class="keywordtype">void</span> setCall(<a class="code" href="classTelEngine_1_1CallEndpoint.html" title="An abstract call endpoint.">CallEndpoint</a>* call) <a name="l00062"></a>00062 { m_call = call; } <a name="l00063"></a>00063 <a name="l00064"></a>00064 <span class="keyword">inline</span> <span class="keywordtype">void</span> clearCall() <a name="l00065"></a>00065 { m_call = 0; } <a name="l00066"></a>00066 <a name="l00070"></a>00070 <span class="keywordtype">bool</span> copyParam(<span class="keyword">const</span> <a class="code" href="classTelEngine_1_1NamedList.html" title="A named string container class.">NamedList</a>& original, <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& name, <span class="keywordtype">bool</span> clear = <span class="keyword">false</span>); <a name="l00071"></a>00071 <a name="l00075"></a>00075 <span class="keywordtype">void</span> copyParams(<span class="keyword">const</span> <a class="code" href="classTelEngine_1_1NamedList.html" title="A named string container class.">NamedList</a>& original, <span class="keywordtype">bool</span> clear, ...); <a name="l00076"></a>00076 <span class="keywordtype">void</span> fillParam(<a class="code" href="classTelEngine_1_1NamedList.html" title="A named string container class.">NamedList</a>& target, <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& name, <span class="keywordtype">bool</span> clear = <span class="keyword">false</span>); <a name="l00077"></a>00077 <span class="keywordtype">void</span> fillParams(<a class="code" href="classTelEngine_1_1NamedList.html" title="A named string container class.">NamedList</a>& target); <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="keyword">protected</span>: <a name="l00080"></a>00080 <a class="code" href="classTelEngine_1_1CallEndpoint.html" title="An abstract call endpoint.">CallEndpoint</a>* m_call; <a name="l00081"></a>00081 <span class="keywordtype">int</span> m_route; <a name="l00082"></a>00082 }; <a name="l00083"></a>00083 <a name="l00087"></a><a class="code" href="classTelEngine_1_1CallList.html">00087</a> <span class="keyword">class </span>YPBX_API <a class="code" href="classTelEngine_1_1CallList.html">CallList</a> <a name="l00088"></a>00088 { <a name="l00089"></a>00089 <span class="keyword">public</span>: <a name="l00090"></a>00090 <span class="keyword">inline</span> <span class="keywordtype">void</span> append(<a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a>* call) <a name="l00091"></a>00091 { m_calls.append(call); } <a name="l00092"></a>00092 <span class="keyword">inline</span> <span class="keywordtype">void</span> <span class="keyword">remove</span>(<a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a>* call) <a name="l00093"></a>00093 { m_calls.remove(call,<span class="keyword">false</span>); } <a name="l00094"></a>00094 <a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a>* find(<span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& <span class="keywordtype">id</span>); <a name="l00095"></a>00095 <a class="code" href="classTelEngine_1_1CallInfo.html">CallInfo</a>* find(<span class="keyword">const</span> <a class="code" href="classTelEngine_1_1CallEndpoint.html" title="An abstract call endpoint.">CallEndpoint</a>* call); <a name="l00096"></a>00096 <span class="keyword">protected</span>: <a name="l00097"></a>00097 <a class="code" href="classTelEngine_1_1ObjList.html" title="An object list class.">ObjList</a> m_calls; <a name="l00098"></a>00098 }; <a name="l00099"></a>00099 <a name="l00100"></a>00100 <span class="keyword">class </span>YPBX_API MultiRouter : <span class="keyword">public</span> <a class="code" href="classTelEngine_1_1MessageReceiver.html" title="A multiple message receiver.">MessageReceiver</a> <a name="l00101"></a>00101 { <a name="l00102"></a>00102 <span class="keyword">public</span>: <a name="l00103"></a>00103 <span class="keyword">enum</span> { <a name="l00104"></a>00104 Route, <a name="l00105"></a>00105 Execute, <a name="l00106"></a>00106 Hangup, <a name="l00107"></a>00107 Disconnected <a name="l00108"></a>00108 }; <a name="l00109"></a>00109 MultiRouter(); <a name="l00110"></a>00110 <span class="keyword">virtual</span> ~MultiRouter(); <a name="l00111"></a>00111 <span class="keywordtype">void</span> setup(<span class="keywordtype">int</span> priority = 0); <a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> received(Message& msg, <span class="keywordtype">int</span> <span class="keywordtype">id</span>); <a name="l00113"></a>00113 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> msgRoute(Message& msg, CallInfo& info, <span class="keywordtype">bool</span> first); <a name="l00114"></a>00114 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> msgExecute(Message& msg, CallInfo& info, <span class="keywordtype">bool</span> first); <a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> msgDisconnected(Message& msg, CallInfo& info); <a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">void</span> msgHangup(Message& msg, CallInfo& info); <a name="l00117"></a>00117 <span class="keyword">virtual</span> Message* buildExecute(CallInfo& info, <span class="keywordtype">bool</span> reroute) = 0; <a name="l00118"></a>00118 Message* defaultExecute(CallInfo& info, <span class="keyword">const</span> <span class="keywordtype">char</span>* route = 0); <a name="l00119"></a>00119 <span class="keyword">protected</span>: <a name="l00120"></a>00120 CallList m_list; <a name="l00121"></a>00121 Mutex m_mutex; <a name="l00122"></a>00122 <span class="keyword">private</span>: <a name="l00123"></a>00123 MessageRelay* m_relRoute; <a name="l00124"></a>00124 MessageRelay* m_relExecute; <a name="l00125"></a>00125 MessageRelay* m_relHangup; <a name="l00126"></a>00126 MessageRelay* m_relDisconnected; <a name="l00127"></a>00127 }; <a name="l00128"></a>00128 <a name="l00129"></a>00129 <span class="keyword">class </span>ChanAssistList; <a name="l00130"></a>00130 <a name="l00134"></a><a class="code" href="classTelEngine_1_1ChanAssist.html">00134</a> <span class="keyword">class </span>YPBX_API <a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a> : <span class="keyword">public</span> <a class="code" href="classTelEngine_1_1RefObject.html">RefObject</a> <a name="l00135"></a>00135 { <a name="l00136"></a>00136 <span class="keyword">public</span>: <a name="l00140"></a>00140 <span class="keyword">virtual</span> ~<a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>(); <a name="l00141"></a>00141 <a name="l00146"></a><a class="code" href="classTelEngine_1_1ChanAssist.html#4a7bd56fb99593ace9379ed699f2719c">00146</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& toString()<span class="keyword"> const</span> <a name="l00147"></a>00147 <span class="keyword"> </span>{ <span class="keywordflow">return</span> m_chanId; } <a name="l00148"></a>00148 <a name="l00153"></a>00153 <span class="keyword">virtual</span> <span class="keywordtype">void</span> msgStartup(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg); <a name="l00154"></a>00154 <a name="l00159"></a>00159 <span class="keyword">virtual</span> <span class="keywordtype">void</span> msgHangup(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg); <a name="l00160"></a>00160 <a name="l00165"></a>00165 <span class="keyword">virtual</span> <span class="keywordtype">void</span> msgExecute(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg); <a name="l00166"></a>00166 <a name="l00172"></a>00172 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> msgDisconnect(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg, <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& reason); <a name="l00173"></a>00173 <a name="l00178"></a><a class="code" href="classTelEngine_1_1ChanAssist.html#8796aeecc0233bd722d0bf6a78eb9d5c">00178</a> <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>* list()<span class="keyword"> const</span> <a name="l00179"></a>00179 <span class="keyword"> </span>{ <span class="keywordflow">return</span> m_list; } <a name="l00180"></a>00180 <a name="l00185"></a><a class="code" href="classTelEngine_1_1ChanAssist.html#e537a056a2d8316444575696aa701bbd">00185</a> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& id()<span class="keyword"> const</span> <a name="l00186"></a>00186 <span class="keyword"> </span>{ <span class="keywordflow">return</span> m_chanId; } <a name="l00187"></a>00187 <a name="l00193"></a>00193 <span class="keyword">static</span> <a class="code" href="classTelEngine_1_1RefPointer.html" title="Templated smart pointer class.">RefPointer<CallEndpoint></a> locate(<span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& <span class="keywordtype">id</span>); <a name="l00194"></a>00194 <a name="l00199"></a><a class="code" href="classTelEngine_1_1ChanAssist.html#214dd268af691f4daa3c48f0ff9bb412">00199</a> <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1RefPointer.html" title="Templated smart pointer class.">RefPointer<CallEndpoint></a> locate()<span class="keyword"> const</span> <a name="l00200"></a>00200 <span class="keyword"> </span>{ <span class="keywordflow">return</span> <a class="code" href="classTelEngine_1_1ChanAssist.html#214dd268af691f4daa3c48f0ff9bb412">locate</a>(m_chanId); } <a name="l00201"></a>00201 <a name="l00202"></a>00202 <span class="keyword">protected</span>: <a name="l00208"></a><a class="code" href="classTelEngine_1_1ChanAssist.html#9d2643edcf62c46edd920395380e6c85">00208</a> <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>(<a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>* list, <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& <span class="keywordtype">id</span>) <a name="l00209"></a>00209 : m_list(list), m_chanId(id) <a name="l00210"></a>00210 { } <a name="l00211"></a>00211 <span class="keyword">private</span>: <a name="l00212"></a>00212 <a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>(); <span class="comment">// no default constructor please</span> <a name="l00213"></a>00213 <a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>* m_list; <a name="l00214"></a>00214 <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> m_chanId; <a name="l00215"></a>00215 }; <a name="l00216"></a>00216 <a name="l00221"></a><a class="code" href="classTelEngine_1_1ChanAssistList.html">00221</a> <span class="keyword">class </span>YPBX_API <a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a> : <span class="keyword">public</span> <a class="code" href="classTelEngine_1_1Module.html" title="A Plugin that implements a module.">Module</a> <a name="l00222"></a>00222 { <a name="l00223"></a>00223 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>; <a name="l00224"></a>00224 <span class="keyword">public</span>: <a name="l00228"></a>00228 <span class="keyword">enum</span> { <a name="l00229"></a>00229 Startup = Private, <a name="l00230"></a>00230 Hangup, <a name="l00231"></a>00231 Disconnected, <a name="l00232"></a>00232 AssistPrivate <a name="l00233"></a>00233 }; <a name="l00234"></a>00234 <a name="l00238"></a><a class="code" href="classTelEngine_1_1ChanAssistList.html#06e2ed317cc0e91b92a1660ebefdefba">00238</a> <span class="keyword">virtual</span> ~<a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>() <a name="l00239"></a>00239 { } <a name="l00240"></a>00240 <a name="l00247"></a>00247 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> received(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg, <span class="keywordtype">int</span> <span class="keywordtype">id</span>); <a name="l00248"></a>00248 <a name="l00256"></a>00256 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> received(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>* assist); <a name="l00257"></a>00257 <a name="l00261"></a>00261 <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialize(); <a name="l00262"></a>00262 <a name="l00269"></a>00269 <span class="keyword">virtual</span> <a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>* create(<a class="code" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a>& msg, <span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& <span class="keywordtype">id</span>) = 0; <a name="l00270"></a>00270 <a name="l00275"></a>00275 <span class="keyword">virtual</span> <span class="keywordtype">void</span> init(<span class="keywordtype">int</span> priority = 15); <a name="l00276"></a>00276 <a name="l00282"></a><a class="code" href="classTelEngine_1_1ChanAssistList.html#3e5d564cdd6292e88a63870b63b610f6">00282</a> <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>* find(<span class="keyword">const</span> <a class="code" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>& <span class="keywordtype">id</span>)<span class="keyword"> const</span> <a name="l00283"></a>00283 <span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>*<span class="keyword">></span>(m_calls[id]); } <a name="l00284"></a>00284 <a name="l00285"></a>00285 <span class="keyword">protected</span>: <a name="l00291"></a><a class="code" href="classTelEngine_1_1ChanAssistList.html#87e12718d7e3d712cf7544ac2efde59d">00291</a> <span class="keyword">inline</span> <a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">bool</span> earlyInit = <span class="keyword">false</span>) <a name="l00292"></a>00292 : <a class="code" href="classTelEngine_1_1Module.html" title="A Plugin that implements a module.">Module</a>(name, <span class="stringliteral">"misc"</span>, earlyInit), m_first(true) <a name="l00293"></a>00293 { } <a name="l00294"></a>00294 <a name="l00299"></a>00299 <span class="keywordtype">void</span> removeAssist(<a class="code" href="classTelEngine_1_1ChanAssist.html">ChanAssist</a>* assist); <a name="l00300"></a>00300 <a name="l00301"></a>00301 <span class="keyword">private</span>: <a name="l00302"></a>00302 <a class="code" href="classTelEngine_1_1ChanAssistList.html">ChanAssistList</a>(); <span class="comment">// no default constructor please</span> <a name="l00303"></a>00303 <a class="code" href="classTelEngine_1_1HashList.html" title="A hashed object list class.">HashList</a> m_calls; <a name="l00304"></a>00304 <span class="keywordtype">bool</span> m_first; <a name="l00305"></a>00305 }; <a name="l00306"></a>00306 <a name="l00307"></a>00307 } <a name="l00308"></a>00308 <span class="comment">/* vi: set ts=8 sw=4 sts=4 noet: */</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:10 2008 for Yate by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> </body> </html>