Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 474

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: SS7Layer3 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a>
  </div>
</div>
<div class="contents">
<h1>SS7Layer3 Class Reference</h1><!-- doxytag: class="TelEngine::SS7Layer3" --><!-- doxytag: inherits="TelEngine::SignallingComponent" -->Abstract SS7 layer 3 (network) message transfer part.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="yatesig_8h-source.html">yatesig.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for SS7Layer3:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1SS7Layer3.png" usemap="#SS7Layer3_map" border="0" alt=""></center>
<map name="SS7Layer3_map">
<area href="classTelEngine_1_1SignallingComponent.html" alt="SignallingComponent" shape="rect" coords="140,56,270,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="70,0,200,24">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="210,0,340,24">
<area href="classTelEngine_1_1SS7M3UA.html" alt="SS7M3UA" shape="rect" coords="0,168,130,192">
<area href="classTelEngine_1_1SS7MTP3.html" alt="SS7MTP3" shape="rect" coords="140,168,270,192">
<area href="classTelEngine_1_1SS7Router.html" alt="SS7Router" shape="rect" coords="280,168,410,192">
</map>
</div>

<p>
<a href="classTelEngine_1_1SS7Layer3-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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#277310a4aa4b0e060f8eaa1fc4f648ad">~SS7Layer3</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#91d66a1e1787da747aefa60399686fcd">transmitMSU</a> (const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;msu, const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;label, int sls=-1)=0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#e7844491a5ab570be900a8ad71fc178e">operational</a> (int sls=-1) const =0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#57bde227b197e9e732982e9146050a22">attach</a> (<a class="el" href="classTelEngine_1_1SS7L3User.html">SS7L3User</a> *l3user)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SS7L3User.html">SS7L3User</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#106ba57c8f325da6c70d78c329bed197">user</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#eeae0d397a6dfab82b11c8e11112eb4f">type</a> (unsigned char netType) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#310c1601a8e05a0b8edc5357cf1a9f7b">setType</a> (<a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a> type, unsigned char netType)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#5593d494951763190a5448749864faa1">setType</a> (<a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a> type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#3856c813390c0dbc42a1e9b417ec8fd0">buildRoutes</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;params)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#1cffdee0e470dcf538fe936148940cc9">getRoutePriority</a> (<a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a> type, unsigned int packedPC)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#0e49859bdc4de0a01bfbebe5c17fc0e0">printRoutes</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#d0404e9c6e048dd7f439f07eb56df417">SS7Layer3</a> (<a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a> type=SS7PointCode::Other)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#9a75dbf0d80018fa82e49fa379535f51">receivedMSU</a> (const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;msu, const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;label, int sls)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#7d7c2dac0d938c638e95f7cbddfe728e">notify</a> (int sls=-1)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#cb04f8b39ab435a1eb94ceee4d92af4a">maintenance</a> (const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;msu, const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;label, int sls)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#3bedda8cd039bbf20bb220103f8ded49">management</a> (const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;msu, const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;label, int sls)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#a985002603f4e78a32e79b4ada9c6b9e">unavailable</a> (const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;msu, const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;label, int sls, unsigned char cause=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SS7Route.html">SS7Route</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#e44784837a1a6da8bed868dfeebab362">findRoute</a> (<a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a> type, unsigned int packed)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#5d444112bfffd095f54fae807d5307ec">updateRoutes</a> (<a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a> *network)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SS7Layer3.html#ea2fdf214f2a6913fb6e47058879489b">removeRoutes</a> (<a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a> *network)</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="724d1badd026d7b3b8465d96cd7bf573"></a><!-- doxytag: member="TelEngine::SS7Layer3::SS7Router" ref="724d1badd026d7b3b8465d96cd7bf573" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>SS7Router</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract SS7 layer 3 (network) message transfer part. 
<p>
An interface to a Layer 3 (network) SS7 message transfer part <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="277310a4aa4b0e060f8eaa1fc4f648ad"></a><!-- doxytag: member="TelEngine::SS7Layer3::~SS7Layer3" ref="277310a4aa4b0e060f8eaa1fc4f648ad" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor 
</div>
</div><p>
<a class="anchor" name="d0404e9c6e048dd7f439f07eb56df417"></a><!-- doxytag: member="TelEngine::SS7Layer3::SS7Layer3" ref="d0404e9c6e048dd7f439f07eb56df417" args="(SS7PointCode::Type type=SS7PointCode::Other)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a>&nbsp;</td>
          <td class="paramname"> <em>type</em> = <code>SS7PointCode::Other</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Default point code type </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="57bde227b197e9e732982e9146050a22"></a><!-- doxytag: member="TelEngine::SS7Layer3::attach" ref="57bde227b197e9e732982e9146050a22" args="(SS7L3User *l3user)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void attach           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7L3User.html">SS7L3User</a> *&nbsp;</td>
          <td class="paramname"> <em>l3user</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Attach a Layer 3 user component to this network. Detach the old user if valid. Attach itself to the given user <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>l3user</em>&nbsp;</td><td>Pointer to Layer 3 user component to attach </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="3856c813390c0dbc42a1e9b417ec8fd0"></a><!-- doxytag: member="TelEngine::SS7Layer3::buildRoutes" ref="3856c813390c0dbc42a1e9b417ec8fd0" args="(const NamedList &amp;params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool buildRoutes           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>params</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Build the list of outgoing routes serviced by this network. Clear the list before re-building it. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>The parameter list </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if no route available </dd></dl>

</div>
</div><p>
<a class="anchor" name="e44784837a1a6da8bed868dfeebab362"></a><!-- doxytag: member="TelEngine::SS7Layer3::findRoute" ref="e44784837a1a6da8bed868dfeebab362" args="(SS7PointCode::Type type, unsigned int packed)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1SS7Route.html">SS7Route</a>* findRoute           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>packed</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a route having the specified point code type and packed point code. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The point code type used to choose the list of packed point codes </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>packed</em>&nbsp;</td><td>The packed point code to find in the list </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1SS7Route.html" title="A SS7 MSU route.">SS7Route</a> pointer or 0 if type is invalid or the given packed point code was not found </dd></dl>

</div>
</div><p>
<a class="anchor" name="1cffdee0e470dcf538fe936148940cc9"></a><!-- doxytag: member="TelEngine::SS7Layer3::getRoutePriority" ref="1cffdee0e470dcf538fe936148940cc9" args="(SS7PointCode::Type type, unsigned int packedPC)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int getRoutePriority           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>packedPC</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the priority of a route. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Destination point code type </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>packedPC</em>&nbsp;</td><td>The packed point code </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The priority of the route. -1 if no route to the given point code </dd></dl>

</div>
</div><p>
<a class="anchor" name="cb04f8b39ab435a1eb94ceee4d92af4a"></a><!-- doxytag: member="TelEngine::SS7Layer3::maintenance" ref="cb04f8b39ab435a1eb94ceee4d92af4a" args="(const SS7MSU &amp;msu, const SS7Label &amp;label, int sls)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool maintenance           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default processing of a MTN (Maintenance MSU) <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msu</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data, starting with Service Indicator Octet </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>Routing label of the received MSU </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signalling Link the MSU was received from </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the MSU was processed </dd></dl>

</div>
</div><p>
<a class="anchor" name="3bedda8cd039bbf20bb220103f8ded49"></a><!-- doxytag: member="TelEngine::SS7Layer3::management" ref="3bedda8cd039bbf20bb220103f8ded49" args="(const SS7MSU &amp;msu, const SS7Label &amp;label, int sls)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool management           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default processing of a SNM (Management MSU) <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msu</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data, starting with Service Indicator Octet </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>Routing label of the received MSU </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signalling Link the MSU was received from </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the MSU was processed </dd></dl>

</div>
</div><p>
<a class="anchor" name="7d7c2dac0d938c638e95f7cbddfe728e"></a><!-- doxytag: member="TelEngine::SS7Layer3::notify" ref="7d7c2dac0d938c638e95f7cbddfe728e" args="(int sls=&#45;1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void notify           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em> = <code>-1</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Notify out user part about a status change <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signallink Link that generated the notification, -1 if none </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="e7844491a5ab570be900a8ad71fc178e"></a><!-- doxytag: member="TelEngine::SS7Layer3::operational" ref="e7844491a5ab570be900a8ad71fc178e" args="(int sls=&#45;1) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool operational           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em> = <code>-1</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if the network/linkset is fully operational <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signalling Link to check, negative to check if any is operational </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the linkset is enabled and operational </dd></dl>

<p>Implemented in <a class="el" href="classTelEngine_1_1SS7Router.html#e3bd994748f286a9b744b5d1d78d559f">SS7Router</a>, and <a class="el" href="classTelEngine_1_1SS7MTP3.html#e3bd994748f286a9b744b5d1d78d559f">SS7MTP3</a>.</p>

</div>
</div><p>
<a class="anchor" name="0e49859bdc4de0a01bfbebe5c17fc0e0"></a><!-- doxytag: member="TelEngine::SS7Layer3::printRoutes" ref="0e49859bdc4de0a01bfbebe5c17fc0e0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void printRoutes           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Print the destinations or routing table to output 
</div>
</div><p>
<a class="anchor" name="9a75dbf0d80018fa82e49fa379535f51"></a><!-- doxytag: member="TelEngine::SS7Layer3::receivedMSU" ref="9a75dbf0d80018fa82e49fa379535f51" args="(const SS7MSU &amp;msu, const SS7Label &amp;label, int sls)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool receivedMSU           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Push a received <a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> Signal Unit up the protocol stack <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msu</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data, starting with Service Indicator Octet </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>Routing label of the received MSU </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signalling Link the MSU was received from </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if message was successfully delivered to the user component </dd></dl>

</div>
</div><p>
<a class="anchor" name="ea2fdf214f2a6913fb6e47058879489b"></a><!-- doxytag: member="TelEngine::SS7Layer3::removeRoutes" ref="ea2fdf214f2a6913fb6e47058879489b" args="(SS7Layer3 *network)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void removeRoutes           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a> *&nbsp;</td>
          <td class="paramname"> <em>network</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove the given network from all destinations in the routing table. Remove the entry in the routing table if empty (no more routes to the point code). Used by a SS7 router. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>network</em>&nbsp;</td><td>The network to remove </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="5593d494951763190a5448749864faa1"></a><!-- doxytag: member="TelEngine::SS7Layer3::setType" ref="5593d494951763190a5448749864faa1" args="(SS7PointCode::Type type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setType           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the point code of this Layer 3 component for all network types <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Point code type to set </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="310c1601a8e05a0b8edc5357cf1a9f7b"></a><!-- doxytag: member="TelEngine::SS7Layer3::setType" ref="310c1601a8e05a0b8edc5357cf1a9f7b" args="(SS7PointCode::Type type, unsigned char netType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setType           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&nbsp;</td>
          <td class="paramname"> <em>netType</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the point code of this Layer 3 component for a network type <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>Point code type to set for the network type </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>netType</em>&nbsp;</td><td>Type of the network like coded in the MSU NI field </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="91d66a1e1787da747aefa60399686fcd"></a><!-- doxytag: member="TelEngine::SS7Layer3::transmitMSU" ref="91d66a1e1787da747aefa60399686fcd" args="(const SS7MSU &amp;msu, const SS7Label &amp;label, int sls=&#45;1)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int transmitMSU           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em> = <code>-1</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Push a <a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> Signal Unit down the protocol stack <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msu</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data, starting with Service Indicator Octet </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>Routing label of the MSU to use in routing </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signalling Link Selection, negative to choose best </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Link the message was successfully queued to, negative for error </dd></dl>

<p>Implemented in <a class="el" href="classTelEngine_1_1SS7Router.html#a8bdc365bd17ff40cf4b4bae60761bd0">SS7Router</a>, and <a class="el" href="classTelEngine_1_1SS7MTP3.html#a8bdc365bd17ff40cf4b4bae60761bd0">SS7MTP3</a>.</p>

</div>
</div><p>
<a class="anchor" name="eeae0d397a6dfab82b11c8e11112eb4f"></a><!-- doxytag: member="TelEngine::SS7Layer3::type" ref="eeae0d397a6dfab82b11c8e11112eb4f" args="(unsigned char netType) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1SS7PointCode.html#1d1cfd8ffb84e947f82999c682b666a7">SS7PointCode::Type</a> type           </td>
          <td>(</td>
          <td class="paramtype">unsigned char&nbsp;</td>
          <td class="paramname"> <em>netType</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrive the point code type of this Layer 3 component for a MSU type <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>netType</em>&nbsp;</td><td>Type of the network like coded in the MSU NI field </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of codepoint this component will use </dd></dl>

</div>
</div><p>
<a class="anchor" name="a985002603f4e78a32e79b4ada9c6b9e"></a><!-- doxytag: member="TelEngine::SS7Layer3::unavailable" ref="a985002603f4e78a32e79b4ada9c6b9e" args="(const SS7MSU &amp;msu, const SS7Label &amp;label, int sls, unsigned char cause=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool unavailable           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7MSU.html">SS7MSU</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>msu</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SS7Label.html">SS7Label</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sls</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&nbsp;</td>
          <td class="paramname"> <em>cause</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default processing of an unknown MSU - emit an User Part Unavailable <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msu</em>&nbsp;</td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data, starting with Service Indicator Octet </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>Routing label of the received MSU </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sls</em>&nbsp;</td><td>Signalling Link the MSU was received from </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cause</em>&nbsp;</td><td>Unavailability cause code (Q.704 15.17.5) </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the MSU was processed </dd></dl>

</div>
</div><p>
<a class="anchor" name="5d444112bfffd095f54fae807d5307ec"></a><!-- doxytag: member="TelEngine::SS7Layer3::updateRoutes" ref="5d444112bfffd095f54fae807d5307ec" args="(SS7Layer3 *network)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void updateRoutes           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1SS7Layer3.html">SS7Layer3</a> *&nbsp;</td>
          <td class="paramname"> <em>network</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a network to the routing table. Clear all its routes before appending it to the table Used by a SS7 router. This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>network</em>&nbsp;</td><td>The network to add to the routing table </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="106ba57c8f325da6c70d78c329bed197"></a><!-- doxytag: member="TelEngine::SS7Layer3::user" ref="106ba57c8f325da6c70d78c329bed197" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1SS7L3User.html">SS7L3User</a>* user           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Retrive the Layer 3 user component to which this network is attached <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the Layer 3 user this network is attached to </dd></dl>

</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&nbsp;
<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>