Sophie

Sophie

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

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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<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.5 on Fri Oct 5 10:28:27 2001 -->
<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>Socket for RTP stack based on UDP and IPv4. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="rtp_h-source.html">rtp.h</a>&gt;</code>
<p>
<p>Inheritance diagram for UDPIPv4Socket:
<p><center><img src="class_UDPIPv4Socket.gif" usemap="#UDPIPv4Socket_map" border="0"></center>
<map name="UDPIPv4Socket_map">
<area href="class_UDPSocket.html" alt="UDPSocket" shape="rect" coords="0,0,100,24">
</map>
<a href="class_UDPIPv4Socket-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_UDPIPv4Socket.html#a0">UDPIPv4Socket</a> (const InetAddress &amp;ia, tpport_t port)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_UDPIPv4Socket.html#a1">~UDPIPv4Socket</a> ()</td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_UDPIPv4Socket.html#a2">Connect</a> (const InetAddress &amp;ia, tpport_t port)</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="class_UDPIPv4Socket.html#a3">isPendingPacket</a> (<a class="el" href="rtp_h.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_UDPIPv4Socket.html#a4">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_UDPIPv4Socket.html#a5">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_UDPIPv4Socket.html#a6">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_UDPIPv4Socket.html#a7">joinGroup</a> (const InetMcastAddress &amp;ia)</td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_UDPIPv4Socket.html#a8">leaveGroup</a> (const InetMcastAddress &amp;ia)</td></tr>
<tr><td nowrap align=right valign=top>sockerror_t&nbsp;</td><td valign=bottom><a class="el" href="class_UDPIPv4Socket.html#a9">setMcastTTL</a> (uint8 ttl)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="class_UDPIPv4Socket.html#a10">endSocket</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Socket for RTP stack based on UDP and IPv4.
<p>
Wrapper for <a class="el" href="class_UDPSocket.html">UDPSocket</a> that provides the physical I/O related methods needed by the data or control connection of an RTP stack, based on UDP and IPv4. It should be "straightforward" defining wrappers like this for other underlying protocols, and then instantiating the template <a class="el" href="class_T_RTPSocket.html">T_RTPSocket</a> for them.
<p>
<dl compact><dt>
<b>Author(s): </b><dd>
 Federico Montesino &lt;<a href="mailto:p5087@quintero.fie.us.es">p5087@quintero.fie.us.es</a>&gt; </dl>
<p>

<p>
Definition at line <a class="el" href="rtp_h-source.html#l02040">2040</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.<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 nowrap valign="top"><b> 
UDPIPv4Socket::UDPIPv4Socket (
          </b></td>
          <td valign="bottom"><b>
const InetAddress &amp; <em>ia</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
tpport_t <em>port</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>
Constructor.<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>
<p>
Definition at line <a class="el" href="rtp_h-source.html#l02049">2049</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </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 nowrap valign="top"><b> 
UDPIPv4Socket::~UDPIPv4Socket (
          </b></td>
          <td valign="bottom"><b>
)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>
Destructor. 
<p>
Definition at line <a class="el" href="rtp_h-source.html#l02056">2056</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<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 nowrap valign="top"><b> 
sockerror_t UDPIPv4Socket::Connect (
          </b></td>
          <td valign="bottom"><b>
const InetAddress &amp; <em>ia</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
tpport_t <em>port</em>&nbsp;)
          </b></td>
        </tr>

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

<p>
Connect to a foreign socket.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ia</em>
&nbsp;</td><td>
 network 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="a10" 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 nowrap valign="top"><b> 
void UDPIPv4Socket::endSocket (
          </b></td>
          <td valign="bottom"><b>
)<code> [inline]</code>
          </b></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>
Definition at line <a class="el" href="rtp_h-source.html#l02130">2130</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a3" 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 nowrap valign="top"><b> 
bool UDPIPv4Socket::isPendingPacket (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="rtp_h.html#a1">microtimeout_t</a> <em>timeout</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>

<p>
Definition at line <a class="el" href="rtp_h-source.html#l02072">2072</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a7" 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 nowrap valign="top"><b> 
sockerror_t UDPIPv4Socket::joinGroup (
          </b></td>
          <td valign="bottom"><b>
const InetMcastAddress &amp; <em>ia</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>
Join a multicast group.<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>
<p>
Definition at line <a class="el" href="rtp_h-source.html#l02103">2103</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a8" 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 nowrap valign="top"><b> 
sockerror_t UDPIPv4Socket::leaveGroup (
          </b></td>
          <td valign="bottom"><b>
const InetMcastAddress &amp; <em>ia</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>
Leave a multicast group.<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>
<p>
Definition at line <a class="el" href="rtp_h-source.html#l02113">2113</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a5" 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 nowrap valign="top"><b> 
size_t UDPIPv4Socket::readPacket (
          </b></td>
          <td valign="bottom"><b>
unsigned char * <em>buffer</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
size_t <em>len</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>

<p>
Definition at line <a class="el" href="rtp_h-source.html#l02086">2086</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a9" 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 nowrap valign="top"><b> 
sockerror_t UDPIPv4Socket::setMcastTTL (
          </b></td>
          <td valign="bottom"><b>
uint8 <em>ttl</em>&nbsp;)<code> [inline]</code>
          </b></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.<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>
<p>
Definition at line <a class="el" href="rtp_h-source.html#l02123">2123</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a6" 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 nowrap valign="top"><b> 
sockerror_t UDPIPv4Socket::setMulticast (
          </b></td>
          <td valign="bottom"><b>
bool <em>enable</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>

<p>
Definition at line <a class="el" href="rtp_h-source.html#l02093">2093</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<a name="a4" 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 nowrap valign="top"><b> 
size_t UDPIPv4Socket::writePacket (
          </b></td>
          <td valign="bottom"><b>
const unsigned char *const <em>buffer</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
size_t <em>len</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

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

<p>

<p>
Definition at line <a class="el" href="rtp_h-source.html#l02079">2079</a> of file <a class="el" href="rtp_h-source.html">rtp.h</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rtp_h-source.html">rtp.h</a></ul>
<hr><address><small>Generated at Fri Oct 5 10:28:27 2001 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.5 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