<!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: SIGTRAN 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_1SIGTRAN.html">SIGTRAN</a>
</div>
</div>
<div class="contents">
<h1>SIGTRAN Class Reference</h1><!-- doxytag: class="TelEngine::SIGTRAN" -->Abstract <a class="el" href="classTelEngine_1_1SIGTRAN.html" title="Abstract SIGTRAN component.">SIGTRAN</a> component.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatesig_8h-source.html">yatesig.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for SIGTRAN:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1SIGTRAN.png" usemap="#SIGTRAN_map" border="0" alt=""></center>
<map name="SIGTRAN_map">
<area href="classTelEngine_1_1ISDNIUA.html" alt="ISDNIUA" shape="rect" coords="0,56,70,80">
<area href="classTelEngine_1_1SS7M2PA.html" alt="SS7M2PA" shape="rect" coords="80,56,150,80">
<area href="classTelEngine_1_1SS7M2UA.html" alt="SS7M2UA" shape="rect" coords="160,56,230,80">
<area href="classTelEngine_1_1SS7M3UA.html" alt="SS7M3UA" shape="rect" coords="240,56,310,80">
<area href="classTelEngine_1_1SS7SUA.html" alt="SS7SUA" shape="rect" coords="320,56,390,80">
</map>
</div>
<p>
<a href="classTelEngine_1_1SIGTRAN-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIGTRAN.html#dd50664cea8109125ea877935f13d5fd">Transport</a> { <b>None</b> = 0,
<b>Sctp</b>,
<b>Tcp</b>,
<b>Unix</b>
}</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_1SIGTRAN.html#715acfbde2cbbb5a2df20a29b47ddd19">SIGTRAN</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIGTRAN.html#5da4c6f2bf296df77216d666d6c3eec5">~SIGTRAN</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIGTRAN.html#e93488758054502fec41a77ba3abae42">terminate</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIGTRAN.html#86dda3df7bbf1c226ce37dfa197aa92a">attach</a> (<a class="el" href="classTelEngine_1_1Socket.html">Socket</a> *socket, <a class="el" href="classTelEngine_1_1SIGTRAN.html#dd50664cea8109125ea877935f13d5fd">Transport</a> trans)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SIGTRAN.html#e8805f87b3e6168643bfaeca44cef365">processMSG</a> (unsigned char msgVersion, unsigned char msgClass, unsigned char msgType, const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &msg)=0</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract <a class="el" href="classTelEngine_1_1SIGTRAN.html" title="Abstract SIGTRAN component.">SIGTRAN</a> component.
<p>
An interface to a Signalling Transport component <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="dd50664cea8109125ea877935f13d5fd"></a><!-- doxytag: member="TelEngine::SIGTRAN::Transport" ref="dd50664cea8109125ea877935f13d5fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1SIGTRAN.html#dd50664cea8109125ea877935f13d5fd">Transport</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Type of transport used
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="715acfbde2cbbb5a2df20a29b47ddd19"></a><!-- doxytag: member="TelEngine::SIGTRAN::SIGTRAN" ref="715acfbde2cbbb5a2df20a29b47ddd19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SIGTRAN.html">SIGTRAN</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs an uninitialized signalling transport
</div>
</div><p>
<a class="anchor" name="5da4c6f2bf296df77216d666d6c3eec5"></a><!-- doxytag: member="TelEngine::SIGTRAN::~SIGTRAN" ref="5da4c6f2bf296df77216d666d6c3eec5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1SIGTRAN.html">SIGTRAN</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor, closes connection and any socket
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="86dda3df7bbf1c226ce37dfa197aa92a"></a><!-- doxytag: member="TelEngine::SIGTRAN::attach" ref="86dda3df7bbf1c226ce37dfa197aa92a" args="(Socket *socket, Transport trans)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Socket.html">Socket</a> * </td>
<td class="paramname"> <em>socket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SIGTRAN.html#dd50664cea8109125ea877935f13d5fd">Transport</a> </td>
<td class="paramname"> <em>trans</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach an open socket <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>socket</em> </td><td>Already open socket to attach </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>Type of the socket (transport) </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the new socket was attached successfully </dd></dl>
</div>
</div><p>
<a class="anchor" name="e8805f87b3e6168643bfaeca44cef365"></a><!-- doxytag: member="TelEngine::SIGTRAN::processMSG" ref="e8805f87b3e6168643bfaeca44cef365" args="(unsigned char msgVersion, unsigned char msgClass, unsigned char msgType, const DataBlock &msg)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool processMSG </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>msgVersion</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>msgClass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>msgType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>msg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process a complete 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>msgVersion</em> </td><td>Version of the protocol </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msgClass</em> </td><td>Class of the message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msgType</em> </td><td>Type of the message, depends on the class </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data, may be empty </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the message was handled </dd></dl>
</div>
</div><p>
<a class="anchor" name="e93488758054502fec41a77ba3abae42"></a><!-- doxytag: member="TelEngine::SIGTRAN::terminate" ref="e93488758054502fec41a77ba3abae42" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void terminate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Terminate the transport, close the socket, drop partial data
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatesig_8h-source.html">yatesig.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:14 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
>
434
