Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 56ebf73a8cc21535297a85df4640d63b > files > 140

libccrtp0.7-0.7.2-1mdk.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>UDPIPv4Socket class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindex" href="examples.html">Examples</a> &nbsp; </center>
<hr><h1>UDPIPv4Socket  Class Reference</h1>Wrapper for one or several sockets that provide the physical I/O related methods needed by the data or control connection of an RTP stack, based on UDP and IPv4. Socket for RTP stack based on UDP and IPv4. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="rtp_8h-source.html">rtp.h</a>&gt;</code>
<p>
<p>Inheritance diagram for UDPIPv4Socket::
<p><center><img src="class_u_d_p_i_pv4_socket.gif" usemap="#UDPIPv4Socket_map" border="0"></center>
<map name="UDPIPv4Socket_map">
<area href="class_u_d_p_receive.html" alt="UDPReceive" shape="rect" coords="0,0,100,24">
<area href="class_u_d_p_transmit.html" alt="UDPTransmit" shape="rect" coords="110,0,210,24">
</map>
<a href="class_u_d_p_i_pv4_socket-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a0">UDPIPv4Socket</a> (const InetAddress &amp;ia, tpport_t port)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a1">~UDPIPv4Socket</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a2">Connect</a> (const InetHostAddress &amp;ia, tpport_t port)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Connect to a foreign socket.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a3">Connect</a> (const InetMcastAddress &amp;ia, tpport_t port)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Connect to a foreign socket.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a4">isPendingPacket</a> (<a class="el" href="rtp_8h.html#a1">microtimeout_t</a> timeout)</td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a5">writePacket</a> (const unsigned char *const buffer, size_t len)</td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a6">readPacket</a> (unsigned char *buffer, size_t len)</td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a7">setMulticast</a> (bool enable)</td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a8">joinGroup</a> (const InetMcastAddress &amp;ia)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Join a multicast group.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a9">leaveGroup</a> (const InetMcastAddress &amp;ia)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Leave a multicast group.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a10">setMcastTTL</a> (uint8 ttl)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the value of the TTL field in the packets to send.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="class_u_d_p_i_pv4_socket.html#a11">endSocket</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>End socket, terminating the socket connection.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Wrapper for one or several sockets that provide the physical I/O related methods needed by the data or control connection of an RTP stack, based on UDP and IPv4. Socket for RTP stack based on UDP and IPv4.
<p>
It should be "straightforward" defining wrappers like this for other underlying protocols, and then instantiating the template <a class="el" href="class_t___r_t_p_socket.html">T_RTPSocket</a> for them.
<p>
Generally, the socket used to transmit does not have to be the same as the one used to receive packets.
<p>
<dl compact><dt><b>
Author: </b><dd>
Federico Montesino &lt;<a href="mailto:p5087@quintero.fie.us.es">p5087@quintero.fie.us.es</a>&gt; </dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="UDPIPv4Socket::UDPIPv4Socket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> UDPIPv4Socket::UDPIPv4Socket </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const InetAddress &amp;</td>
          <td class="mdname">&nbsp; <em>ia</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">tpport_t</td>
          <td class="mdname">&nbsp; <em>port</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>bind
</em>&nbsp;</td><td>
network address this socket is to be bound  </td></tr>
<tr><td valign=top><em>port
</em>&nbsp;</td><td>
transport port this socket is to be bound </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a1" doxytag="UDPIPv4Socket::~UDPIPv4Socket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> UDPIPv4Socket::~UDPIPv4Socket </td>
          <td class="md">(&nbsp;</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Destructor.
<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="UDPIPv4Socket::Connect"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> sockerror_t UDPIPv4Socket::Connect </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const InetMcastAddress &amp;</td>
          <td class="mdname">&nbsp; <em>ia</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">tpport_t</td>
          <td class="mdname">&nbsp; <em>port</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Connect to a foreign socket.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ia
</em>&nbsp;</td><td>
multicast address to connect to </td></tr>
<tr><td valign=top><em>port
</em>&nbsp;</td><td>
transport port to connect to </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a2" doxytag="UDPIPv4Socket::Connect"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> sockerror_t UDPIPv4Socket::Connect </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const InetHostAddress &amp;</td>
          <td class="mdname">&nbsp; <em>ia</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">tpport_t</td>
          <td class="mdname">&nbsp; <em>port</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Connect to a foreign socket.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ia
</em>&nbsp;</td><td>
host address to connect to </td></tr>
<tr><td valign=top><em>port
</em>&nbsp;</td><td>
transport port to connect to </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a11" doxytag="UDPIPv4Socket::endSocket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void UDPIPv4Socket::endSocket </td>
          <td class="md">(&nbsp;</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
End socket, terminating the socket connection.
<p>
    </td>
  </tr>
</table>
<a name="a4" doxytag="UDPIPv4Socket::isPendingPacket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool UDPIPv4Socket::isPendingPacket </td>
          <td class="md">(&nbsp;</td>
          <td class="md"><a class="el" href="rtp_8h.html#a1">microtimeout_t</a></td>
          <td class="mdname1">&nbsp; <em>timeout</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a8" doxytag="UDPIPv4Socket::joinGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> sockerror_t UDPIPv4Socket::joinGroup </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const InetMcastAddress &amp;</td>
          <td class="mdname1">&nbsp; <em>ia</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Join a multicast group.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ia
</em>&nbsp;</td><td>
multicast group address  </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
error code from the socket operation </dl>    </td>
  </tr>
</table>
<a name="a9" doxytag="UDPIPv4Socket::leaveGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> sockerror_t UDPIPv4Socket::leaveGroup </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const InetMcastAddress &amp;</td>
          <td class="mdname1">&nbsp; <em>ia</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Leave a multicast group.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ia
</em>&nbsp;</td><td>
multicast group address  </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
error code from the socket operation </dl>    </td>
  </tr>
</table>
<a name="a6" doxytag="UDPIPv4Socket::readPacket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> size_t UDPIPv4Socket::readPacket </td>
          <td class="md">(&nbsp;</td>
          <td class="md">unsigned char *</td>
          <td class="mdname">&nbsp; <em>buffer</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">size_t</td>
          <td class="mdname">&nbsp; <em>len</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a10" doxytag="UDPIPv4Socket::setMcastTTL"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> sockerror_t UDPIPv4Socket::setMcastTTL </td>
          <td class="md">(&nbsp;</td>
          <td class="md">uint8</td>
          <td class="mdname1">&nbsp; <em>ttl</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the value of the TTL field in the packets to send.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ttl
</em>&nbsp;</td><td>
Time To Live </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
error code from the socket operation </dl>    </td>
  </tr>
</table>
<a name="a7" doxytag="UDPIPv4Socket::setMulticast"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> sockerror_t UDPIPv4Socket::setMulticast </td>
          <td class="md">(&nbsp;</td>
          <td class="md">bool</td>
          <td class="mdname1">&nbsp; <em>enable</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a5" doxytag="UDPIPv4Socket::writePacket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> size_t UDPIPv4Socket::writePacket </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const unsigned char *const</td>
          <td class="mdname">&nbsp; <em>buffer</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">size_t</td>
          <td class="mdname">&nbsp; <em>len</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rtp_8h-source.html">rtp.h</a></ul>
<hr><address><small>Generated at Sat Jan 5 09:08:56 2002 for ccRTP by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional