<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::UDPDuplex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_u_d_p_duplex.html">UDPDuplex</a>
</div>
</div>
<div class="contents">
<h1>ost::UDPDuplex Class Reference</h1><!-- doxytag: class="ost::UDPDuplex" --><!-- doxytag: inherits="ost::UDPTransmit,ost::UDPReceive" -->
<p>UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="socket_8h_source.html">socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::UDPDuplex:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_u_d_p_duplex.png" usemap="#ost::UDPDuplex_map" alt=""/>
<map id="ost::UDPDuplex_map" name="ost::UDPDuplex_map">
<area href="classost_1_1_u_d_p_transmit.html" alt="ost::UDPTransmit" shape="rect" coords="0,112,106,136"/>
<area href="classost_1_1_u_d_p_receive.html" alt="ost::UDPReceive" shape="rect" coords="116,112,222,136"/>
<area href="classost_1_1_u_d_p_socket.html" alt="ost::UDPSocket" shape="rect" coords="0,56,106,80"/>
<area href="classost_1_1_u_d_p_socket.html" alt="ost::UDPSocket" shape="rect" coords="116,56,222,80"/>
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,106,24"/>
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="116,0,222,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_u_d_p_duplex-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_duplex.html#a4e7880d62525ae7256b802b45820eb83">UDPDuplex</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &bind, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses. <a href="#a4e7880d62525ae7256b802b45820eb83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_duplex.html#ac808bc00d4be2b4af3d69e88beeefb2e">UDPDuplex</a> (const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &bind, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_duplex.html#a219b6497a5dd25e943639cfc1bbb8f81">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Associate the duplex with a specified peer host. <a href="#a219b6497a5dd25e943639cfc1bbb8f81"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_duplex.html#a60abbfd8ef6eac65c8b9726a1d489440">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_duplex.html#afa88407cb5be59e11154ce250a5a5c5c">disconnect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disassociate this duplex from any host connection. <a href="#afa88407cb5be59e11154ce250a5a5c5c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts. </p>
<p>Two UDP sockets are typically used on alternating port addresses to assure that sender and receiver data does not collide or echo back. A UDP Duplex is commonly used for full duplex real-time streaming of UDP data between hosts.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Unreliable Datagram Peer Associations. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4e7880d62525ae7256b802b45820eb83"></a><!-- doxytag: member="ost::UDPDuplex::UDPDuplex" ref="a4e7880d62525ae7256b802b45820eb83" args="(const IPV4Address &bind, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPDuplex::UDPDuplex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="paramname"> <em>bind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bind</em> </td><td>address to bind this socket to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to bind sender. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac808bc00d4be2b4af3d69e88beeefb2e"></a><!-- doxytag: member="ost::UDPDuplex::UDPDuplex" ref="ac808bc00d4be2b4af3d69e88beeefb2e" args="(const IPV6Address &bind, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPDuplex::UDPDuplex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> & </td>
<td class="paramname"> <em>bind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a60abbfd8ef6eac65c8b9726a1d489440"></a><!-- doxytag: member="ost::UDPDuplex::connect" ref="a60abbfd8ef6eac65c8b9726a1d489440" args="(const IPV6Host &host, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPDuplex::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_receive.html#a0e8c851cbc68729353b76894107091e9">ost::UDPReceive</a>.</p>
</div>
</div>
<a class="anchor" id="a219b6497a5dd25e943639cfc1bbb8f81"></a><!-- doxytag: member="ost::UDPDuplex::connect" ref="a219b6497a5dd25e943639cfc1bbb8f81" args="(const IPV4Host &host, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPDuplex::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Associate the duplex with a specified peer host. </p>
<p>Both the sender and receiver will be interconnected with the remote host.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, error code on error. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>address to connect socket to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to connect socket to. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_transmit.html#ad9b9d46dfaf10ad1555c0fa08db339be">ost::UDPTransmit</a>.</p>
</div>
</div>
<a class="anchor" id="afa88407cb5be59e11154ce250a5a5c5c"></a><!-- doxytag: member="ost::UDPDuplex::disconnect" ref="afa88407cb5be59e11154ce250a5a5c5c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPDuplex::disconnect </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disassociate this duplex from any host connection. </p>
<p>No data should be read or written until a connection is established.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, error code on error. </dd></dl>
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#acb4faa86204e7b37bf447f4802c8940d">ost::UDPSocket</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="socket_8h_source.html">socket.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
418
