<!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: MGCPMessage Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a>
</div>
</div>
<div class="contents">
<h1>MGCPMessage Class Reference</h1><!-- doxytag: class="TelEngine::MGCPMessage" --><!-- doxytag: inherits="TelEngine::RefObject" -->An MGCP command or response.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatemgcp_8h-source.html">yatemgcp.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for MGCPMessage:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1MGCPMessage.png" usemap="#MGCPMessage_map" border="0" alt=""></center>
<map name="MGCPMessage_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,100,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,100,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1MGCPMessage-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#0f5984cf915fefc2f64b015f695531cb">MGCPMessage</a> (<a class="el" href="classTelEngine_1_1MGCPEngine.html">MGCPEngine</a> *engine, const char *name, const char *ep, const char *ver="MGCP 1.0")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#02974b84e5cd1b1f1b34ba766095084f">MGCPMessage</a> (<a class="el" href="classTelEngine_1_1MGCPTransaction.html">MGCPTransaction</a> *trans, unsigned int code, const char *comment=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#f1d229c31c465e94b5e4ccb69feef9a4">~MGCPMessage</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#8d985300b138b6c5556ab17ed4df3b38">valid</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#b31e7357671cfe484e3c3ed3cd6258e4">name</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#9fbb542ce0dae274d40866ba432b411a">code</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#be02834a1bc748fc318188e9e54c3c40">version</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#299a3fd110c3eabb8adfc9f8235a2ec9">comment</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#cc6c7f58a3a1d7a0e4c7e5a6b43a8f49">isCommand</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#5f89a108755a6cb3e8185d85c850a816">isResponse</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#c443fdf72682a999d095f5bf11211f0a">isAck</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#0c8e59e64cbab0c8af978c4f51bed6f9">transactionId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#3b22b772544eaaf874b63ca5807a0f78">endpointId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#1a47643c18cdee5bf5ea71522f708e27">toString</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest) const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#8574a449d641ecd19105ed68e1fd6805">parse</a> (<a class="el" href="classTelEngine_1_1MGCPEngine.html">MGCPEngine</a> *engine, <a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> &dest, const unsigned char *buffer, unsigned int len, const char *sdpType="application/<a class="el" href="classTelEngine_1_1MGCPMessage.html#7e8595a03399b14f9bddf86c8e12207e">sdp</a>")</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#843f74eb2ae35223b090dc55e73aab9c">params</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#7e8595a03399b14f9bddf86c8e12207e">sdp</a></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MGCPMessage.html#b74629ee34d6be9d47173a7cce6f7c92">MGCPMessage</a> (<a class="el" href="classTelEngine_1_1MGCPEngine.html">MGCPEngine</a> *engine, const char *name, int code, unsigned int transId, const char *epId, const char *ver)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6360421efa805d198b4c1849eacabcd7"></a><!-- doxytag: member="TelEngine::MGCPMessage::MGCPTransaction" ref="6360421efa805d198b4c1849eacabcd7" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>MGCPTransaction</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An MGCP command or response.
<p>
This class holds an MGCP message, either command or response, along with its parameters. The <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0f5984cf915fefc2f64b015f695531cb"></a><!-- doxytag: member="TelEngine::MGCPMessage::MGCPMessage" ref="0f5984cf915fefc2f64b015f695531cb" args="(MGCPEngine *engine, const char *name, const char *ep, const char *ver="MGCP 1.0")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MGCPEngine.html">MGCPEngine</a> * </td>
<td class="paramname"> <em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ver</em> = <code>"MGCP 1.0"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Construct an outgoing command message. A transaction id will be requested from the endpoint's engine. The message will be invalidated if failed to get a transaction id or the command name is unknown <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>The engine sending this message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Command name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ep</em> </td><td>The id of the endpoint issuing this command </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ver</em> </td><td>The protocol version to use </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="02974b84e5cd1b1f1b34ba766095084f"></a><!-- doxytag: member="TelEngine::MGCPMessage::MGCPMessage" ref="02974b84e5cd1b1f1b34ba766095084f" args="(MGCPTransaction *trans, unsigned int code, const char *comment=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MGCPTransaction.html">MGCPTransaction</a> * </td>
<td class="paramname"> <em>trans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>comment</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Construct an outgoing response message The message will be invalidated if failed to get a transaction id or the code is greater then 999 <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>The transaction to respond </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>The response code ranging from 0 to 999 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>comment</em> </td><td>Optional response comment </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f1d229c31c465e94b5e4ccb69feef9a4"></a><!-- doxytag: member="TelEngine::MGCPMessage::~MGCPMessage" ref="f1d229c31c465e94b5e4ccb69feef9a4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<a class="anchor" name="b74629ee34d6be9d47173a7cce6f7c92"></a><!-- doxytag: member="TelEngine::MGCPMessage::MGCPMessage" ref="b74629ee34d6be9d47173a7cce6f7c92" args="(MGCPEngine *engine, const char *name, int code, unsigned int transId, const char *epId, const char *ver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1MGCPMessage.html">MGCPMessage</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MGCPEngine.html">MGCPEngine</a> * </td>
<td class="paramname"> <em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>transId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>epId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ver</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Used by the parser to construct an incoming message <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>The engine receiving this message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Command name or response comment </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>The response code in the range 0 to 999 or -1 if the received message is a command </td></tr>
<tr><td valign="top"></td><td valign="top"><em>transId</em> </td><td>The id of the transaction owning this message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>epId</em> </td><td>The id of the endpoint issuing this command </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ver</em> </td><td>The protocol version </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9fbb542ce0dae274d40866ba432b411a"></a><!-- doxytag: member="TelEngine::MGCPMessage::code" ref="9fbb542ce0dae274d40866ba432b411a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int code </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the response code if this is a response message <dl class="return" compact><dt><b>Returns:</b></dt><dd>The response code contained in this message </dd></dl>
</div>
</div><p>
<a class="anchor" name="299a3fd110c3eabb8adfc9f8235a2ec9"></a><!-- doxytag: member="TelEngine::MGCPMessage::comment" ref="299a3fd110c3eabb8adfc9f8235a2ec9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& comment </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the comment from a response message <dl class="return" compact><dt><b>Returns:</b></dt><dd>The comment of this message </dd></dl>
</div>
</div><p>
<a class="anchor" name="3b22b772544eaaf874b63ca5807a0f78"></a><!-- doxytag: member="TelEngine::MGCPMessage::endpointId" ref="3b22b772544eaaf874b63ca5807a0f78" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& endpointId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the message's endpoint id if this is a command <dl class="return" compact><dt><b>Returns:</b></dt><dd>The message's endpoint id if this is a command </dd></dl>
</div>
</div><p>
<a class="anchor" name="c443fdf72682a999d095f5bf11211f0a"></a><!-- doxytag: member="TelEngine::MGCPMessage::isAck" ref="c443fdf72682a999d095f5bf11211f0a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isAck </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this message is a response ACK (code is between 0 and 99, including the margins) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this message is a response ACK </dd></dl>
</div>
</div><p>
<a class="anchor" name="cc6c7f58a3a1d7a0e4c7e5a6b43a8f49"></a><!-- doxytag: member="TelEngine::MGCPMessage::isCommand" ref="cc6c7f58a3a1d7a0e4c7e5a6b43a8f49" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isCommand </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this is a command (code is a negative value) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this message is a command </dd></dl>
</div>
</div><p>
<a class="anchor" name="5f89a108755a6cb3e8185d85c850a816"></a><!-- doxytag: member="TelEngine::MGCPMessage::isResponse" ref="5f89a108755a6cb3e8185d85c850a816" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isResponse </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this is a response message (code is greater then or equal to 100) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this message is a response </dd></dl>
</div>
</div><p>
<a class="anchor" name="b31e7357671cfe484e3c3ed3cd6258e4"></a><!-- doxytag: member="TelEngine::MGCPMessage::name" ref="b31e7357671cfe484e3c3ed3cd6258e4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the command name or response code text representation of this message <dl class="return" compact><dt><b>Returns:</b></dt><dd>The command name or response text representation of this message </dd></dl>
</div>
</div><p>
<a class="anchor" name="8574a449d641ecd19105ed68e1fd6805"></a><!-- doxytag: member="TelEngine::MGCPMessage::parse" ref="8574a449d641ecd19105ed68e1fd6805" args="(MGCPEngine *engine, ObjList &dest, const unsigned char *buffer, unsigned int len, const char *sdpType="application/sdp")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MGCPEngine.html">MGCPEngine</a> * </td>
<td class="paramname"> <em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sdpType</em> = <code>"application/<a class="el" href="classTelEngine_1_1MGCPMessage.html#7e8595a03399b14f9bddf86c8e12207e">sdp</a>"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse a received buffer according to RFC 3435. Command and protocol names are converted to upper case. The enpoint id is converted to lower case. <a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> parameter names are converted to lower case if the engine's flag is set. <a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> parameter values and SDP(s) are stored unchanged <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>The receiving engine </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The list of received messages </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer to parse </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The buffer length </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sdpType</em> </td><td>The MIME SDP content type if the message contains any SDP body </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False on failure, true on success. If failed, the destination list may contain a response message to be sent </dd></dl>
</div>
</div><p>
<a class="anchor" name="1a47643c18cdee5bf5ea71522f708e27"></a><!-- doxytag: member="TelEngine::MGCPMessage::toString" ref="1a47643c18cdee5bf5ea71522f708e27" args="(String &dest) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void toString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>dest</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert this message to a string representation to be sent to the remote endpoint or printed to output <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination string </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0c8e59e64cbab0c8af978c4f51bed6f9"></a><!-- doxytag: member="TelEngine::MGCPMessage::transactionId" ref="0c8e59e64cbab0c8af978c4f51bed6f9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int transactionId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the message's transaction id <dl class="return" compact><dt><b>Returns:</b></dt><dd>The message's transaction id </dd></dl>
</div>
</div><p>
<a class="anchor" name="8d985300b138b6c5556ab17ed4df3b38"></a><!-- doxytag: member="TelEngine::MGCPMessage::valid" ref="8d985300b138b6c5556ab17ed4df3b38" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this is a valid message <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this is a valid message </dd></dl>
</div>
</div><p>
<a class="anchor" name="be02834a1bc748fc318188e9e54c3c40"></a><!-- doxytag: member="TelEngine::MGCPMessage::version" ref="be02834a1bc748fc318188e9e54c3c40" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1String.html">String</a>& version </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the protocol version of a command message <dl class="return" compact><dt><b>Returns:</b></dt><dd>The protocol version of this message </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="843f74eb2ae35223b090dc55e73aab9c"></a><!-- doxytag: member="TelEngine::MGCPMessage::params" ref="843f74eb2ae35223b090dc55e73aab9c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> <a class="el" href="classTelEngine_1_1MGCPMessage.html#843f74eb2ae35223b090dc55e73aab9c">params</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Keep the message parameters
</div>
</div><p>
<a class="anchor" name="7e8595a03399b14f9bddf86c8e12207e"></a><!-- doxytag: member="TelEngine::MGCPMessage::sdp" ref="7e8595a03399b14f9bddf86c8e12207e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> <a class="el" href="classTelEngine_1_1MGCPMessage.html#7e8595a03399b14f9bddf86c8e12207e">sdp</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Keep the SDP(s) carried by this message as <a class="el" href="classTelEngine_1_1MimeSdpBody.html" title="MIME for application/sdp.">MimeSdpBody</a> object(s)
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatemgcp_8h-source.html">yatemgcp.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
312
