\section{ost::UDPDuplex Class Reference}
\label{classost_1_1_u_d_p_duplex}\index{ost::UDPDuplex@{ost::UDPDuplex}}
UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.Unreliable Datagram Peer Associations.  


{\tt \#include $<$socket.h$>$}

Inheritance diagram for ost::UDPDuplex::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classost_1_1_u_d_p_duplex}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf UDPDuplex} (const {\bf IPV4Address} \&bind, {\bf tpport\_\-t} port)
\begin{CompactList}\small\item\em Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses. \item\end{CompactList}\item 
{\bf UDPDuplex} (const {\bf IPV6Address} \&bind, {\bf tpport\_\-t} port)
\item 
{\bf Error} {\bf connect} (const {\bf IPV4Host} \&host, {\bf tpport\_\-t} port)
\begin{CompactList}\small\item\em Associate the duplex with a specified peer host. \item\end{CompactList}\item 
{\bf Error} {\bf connect} (const {\bf IPV6Host} \&host, {\bf tpport\_\-t} port)
\item 
{\bf Error} {\bf disconnect} (void)
\begin{CompactList}\small\item\em Disassociate this duplex from any host connection. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.Unreliable Datagram Peer Associations. 

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.

\begin{Desc}
\item[Author:]David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ost::UDPDuplex@{ost::UDPDuplex}!UDPDuplex@{UDPDuplex}}
\index{UDPDuplex@{UDPDuplex}!ost::UDPDuplex@{ost::UDPDuplex}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::UDPDuplex::UDPDuplex (const {\bf IPV4Address} \& {\em bind}, {\bf tpport\_\-t} {\em port})}\label{classost_1_1_u_d_p_duplex_4e7880d62525ae7256b802b45820eb83}


Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em bind}]address to bind this socket to. \item[{\em port}]number to bind sender. \end{description}
\end{Desc}
\index{ost::UDPDuplex@{ost::UDPDuplex}!UDPDuplex@{UDPDuplex}}
\index{UDPDuplex@{UDPDuplex}!ost::UDPDuplex@{ost::UDPDuplex}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::UDPDuplex::UDPDuplex (const {\bf IPV6Address} \& {\em bind}, {\bf tpport\_\-t} {\em port})}\label{classost_1_1_u_d_p_duplex_c808bc00d4be2b4af3d69e88beeefb2e}




\subsection{Member Function Documentation}
\index{ost::UDPDuplex@{ost::UDPDuplex}!connect@{connect}}
\index{connect@{connect}!ost::UDPDuplex@{ost::UDPDuplex}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Error} ost::UDPDuplex::connect (const {\bf IPV6Host} \& {\em host}, {\bf tpport\_\-t} {\em port})}\label{classost_1_1_u_d_p_duplex_60abbfd8ef6eac65c8b9726a1d489440}




Reimplemented from {\bf ost::UDPReceive} {\rm (p.\,\pageref{classost_1_1_u_d_p_receive_0e8c851cbc68729353b76894107091e9})}.\index{ost::UDPDuplex@{ost::UDPDuplex}!connect@{connect}}
\index{connect@{connect}!ost::UDPDuplex@{ost::UDPDuplex}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Error} ost::UDPDuplex::connect (const {\bf IPV4Host} \& {\em host}, {\bf tpport\_\-t} {\em port})}\label{classost_1_1_u_d_p_duplex_219b6497a5dd25e943639cfc1bbb8f81}


Associate the duplex with a specified peer host. 

Both the sender and receiver will be interconnected with the remote host.

\begin{Desc}
\item[Returns:]0 on success, error code on error. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em host}]address to connect socket to. \item[{\em port}]number to connect socket to. \end{description}
\end{Desc}


Reimplemented from {\bf ost::UDPTransmit} {\rm (p.\,\pageref{classost_1_1_u_d_p_transmit_d9b9d46dfaf10ad1555c0fa08db339be})}.\index{ost::UDPDuplex@{ost::UDPDuplex}!disconnect@{disconnect}}
\index{disconnect@{disconnect}!ost::UDPDuplex@{ost::UDPDuplex}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Error} ost::UDPDuplex::disconnect (void)}\label{classost_1_1_u_d_p_duplex_fa88407cb5be59e11154ce250a5a5c5c}


Disassociate this duplex from any host connection. 

No data should be read or written until a connection is established.

\begin{Desc}
\item[Returns:]0 on success, error code on error. \end{Desc}


Reimplemented from {\bf ost::UDPSocket} {\rm (p.\,\pageref{classost_1_1_u_d_p_socket_cb4faa86204e7b37bf447f4802c8940d})}.

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf socket.h}\end{CompactItemize}