\section{CTCPIPComm\-Send Klassenreferenz}
\label{classCTCPIPCommSend}\index{CTCPIPCommSend@{CTCPIPCommSend}}
Class of CTCPIPComm\-Send.  


{\tt \#include $<$TCPIPComm\-Send.h$>$}

Klassendiagramm f\"{u}r CTCPIPComm\-Send::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classCTCPIPCommSend}
\end{center}
\end{figure}
\subsection*{\"{O}ffentliche Methoden}
\begin{CompactItemize}
\item 
{\bf CTCPIPComm\-Send} (const long Max\-Send\-Buffer\-Len=8192)
\begin{CompactList}\small\item\em Conctuctor creates a new object of CTCPIPComm\-Send. \item\end{CompactList}\item 
virtual {\bf $\sim$CTCPIPComm\-Send} ()\label{classCTCPIPCommSend_a1}

\begin{CompactList}\small\item\em destructor \item\end{CompactList}\item 
void {\bf Initialize} (const SOCKET Socket)
\begin{CompactList}\small\item\em Initialize Initializes and starts the connection thread. \item\end{CompactList}\item 
bool {\bf Send} (const void $\ast$p\-Data, const long Data\-Len)
\begin{CompactList}\small\item\em Send Transmits the give data to the communication partner. \item\end{CompactList}\item 
int {\bf Get\-Last\-Socket\-Error} (void) const
\begin{CompactList}\small\item\em Get\-Last\-Socket\-Error Returns the last socket error occured. \item\end{CompactList}\item 
bool {\bf Terminating} (void) const
\begin{CompactList}\small\item\em Terminating (get state) Returns the state whether the class is terminating (destructor) or not. \item\end{CompactList}\item 
void {\bf Terminating} (bool Terminating)
\begin{CompactList}\small\item\em Terminating (set state) Sets the state Terminating according to the parameter. \item\end{CompactList}\end{CompactItemize}
\subsection*{Gesch\"{u}tzte Methoden}
\begin{CompactItemize}
\item 
virtual void {\bf Send\-Dis\-Ind} (void)=0
\begin{CompactList}\small\item\em Send\-Dis\-Ind Indicates that the TCP/IP connection was broken down. \item\end{CompactList}\item 
void {\bf Initialize\-Class} (const long Max\-Send\-Buffer\-Len)
\begin{CompactList}\small\item\em Initializes object data. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private, statische Methoden}
\begin{CompactItemize}
\item 
void {\bf Send\-Thread} ({\bf CTCPIPComm\-Send} $\ast$p\-Class)
\begin{CompactList}\small\item\em Send\-Thread (static) Start function for the Send Thread. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attribute}
\begin{CompactItemize}
\item 
SOCKET {\bf m\_\-Socket}\label{classCTCPIPCommSend_r0}

\item 
int {\bf m\_\-Last\-Socket\-Error}\label{classCTCPIPCommSend_r1}

\item 
DWORD {\bf m\_\-Thread\-ID}\label{classCTCPIPCommSend_r2}

\item 
HANDLE {\bf m\_\-h\-Read\-Pipe}\label{classCTCPIPCommSend_r3}

\item 
HANDLE {\bf m\_\-h\-Write\-Pipe}\label{classCTCPIPCommSend_r4}

\item 
HANDLE {\bf m\_\-Thread\-Handle}\label{classCTCPIPCommSend_r5}

\item 
HANDLE {\bf m\_\-h\-Event\-Terminate}\label{classCTCPIPCommSend_r6}

\item 
HANDLE {\bf m\_\-h\-Event\-Terminate\-Finished}\label{classCTCPIPCommSend_r7}

\item 
HANDLE {\bf m\_\-h\-Event\-Start\-Receiving}\label{classCTCPIPCommSend_r8}

\item 
void $\ast$ {\bf m\_\-p\-Send\-Buffer}\label{classCTCPIPCommSend_r9}

\item 
long {\bf m\_\-Max\-Send\-Buffer\-Len}\label{classCTCPIPCommSend_r10}

\item 
bool {\bf m\_\-Terminating}\label{classCTCPIPCommSend_r11}

\item 
int {\bf m\_\-Send\-Cnt}\label{classCTCPIPCommSend_r12}

\end{CompactItemize}


\subsection{Ausf\"{u}hrliche Beschreibung}
Class of CTCPIPComm\-Send. 

\begin{Desc}
\item[Version:]1.1 \end{Desc}
\begin{Desc}
\item[Autor:]Udo Weber \end{Desc}




\subsection{Beschreibung der Konstruktoren und Destruktoren}
\index{CTCPIPCommSend@{CTCPIPComm\-Send}!CTCPIPCommSend@{CTCPIPCommSend}}
\index{CTCPIPCommSend@{CTCPIPCommSend}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}CTCPIPComm\-Send::CTCPIPComm\-Send (const long {\em Max\-Send\-Buffer\-Len} = {\tt 8192})}\label{classCTCPIPCommSend_a0}


Conctuctor creates a new object of CTCPIPComm\-Send. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em Max\-Send\-Buffer\-Len}]Maximum Lenght sending messages \end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]- \end{Desc}


\subsection{Dokumentation der Elementfunktionen}
\index{CTCPIPCommSend@{CTCPIPComm\-Send}!GetLastSocketError@{GetLastSocketError}}
\index{GetLastSocketError@{GetLastSocketError}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int CTCPIPComm\-Send::Get\-Last\-Socket\-Error (void) const\hspace{0.3cm}{\tt  [inline]}}\label{classCTCPIPCommSend_a4}


Get\-Last\-Socket\-Error Returns the last socket error occured. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em -}]\end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]Last socket error \end{Desc}


Erneute Implementation in {\bf CTCPIPComm} {\rm (S.\,\pageref{classCTCPIPComm_a2})}.\index{CTCPIPCommSend@{CTCPIPComm\-Send}!Initialize@{Initialize}}
\index{Initialize@{Initialize}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CTCPIPComm\-Send::Initialize (const SOCKET {\em Socket})}\label{classCTCPIPCommSend_a2}


Initialize Initializes and starts the connection thread. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em Socket}]The socket to be used for receiving data \end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]- \end{Desc}
\index{CTCPIPCommSend@{CTCPIPComm\-Send}!InitializeClass@{InitializeClass}}
\index{InitializeClass@{InitializeClass}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CTCPIPComm\-Send::Initialize\-Class (const long {\em Max\-Send\-Buffer\-Len})\hspace{0.3cm}{\tt  [protected]}}\label{classCTCPIPCommSend_b1}


Initializes object data. 

Use this to Initialize the class object after construction. \begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em Max\-Send\-Buffer\-Len}]Maximum Lenght sending messages \end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]- \end{Desc}
\index{CTCPIPCommSend@{CTCPIPComm\-Send}!Send@{Send}}
\index{Send@{Send}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool CTCPIPComm\-Send::Send (const void $\ast$ {\em p\-Data}, const long {\em Data\-Len})}\label{classCTCPIPCommSend_a3}


Send Transmits the give data to the communication partner. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em p\-Data}]Pointer to the data to be transmitted \item[{\em Data\-Len}]Length of the given data \end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]true if function call was successful \end{Desc}


Erneute Implementation in {\bf CTCPIPComm} {\rm (S.\,\pageref{classCTCPIPComm_a5})}.\index{CTCPIPCommSend@{CTCPIPComm\-Send}!SendDisInd@{SendDisInd}}
\index{SendDisInd@{SendDisInd}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void CTCPIPComm\-Send::Send\-Dis\-Ind (void)\hspace{0.3cm}{\tt  [protected, pure virtual]}}\label{classCTCPIPCommSend_b0}


Send\-Dis\-Ind Indicates that the TCP/IP connection was broken down. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em -}]\end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]- \end{Desc}


Implementiert in {\bf CTCPIPComm} {\rm (S.\,\pageref{classCTCPIPComm_d3})}.\index{CTCPIPCommSend@{CTCPIPComm\-Send}!SendThread@{SendThread}}
\index{SendThread@{SendThread}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CTCPIPComm\-Send::Send\-Thread ({\bf CTCPIPComm\-Send} $\ast$ {\em p\-Class})\hspace{0.3cm}{\tt  [static, private]}}\label{classCTCPIPCommSend_h0}


Send\-Thread (static) Start function for the Send Thread. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em p\-Class}]Pointer to the current class \end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]- \end{Desc}
\index{CTCPIPCommSend@{CTCPIPComm\-Send}!Terminating@{Terminating}}
\index{Terminating@{Terminating}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CTCPIPComm\-Send::Terminating (bool {\em Terminating})\hspace{0.3cm}{\tt  [inline]}}\label{classCTCPIPCommSend_a6}


Terminating (set state) Sets the state Terminating according to the parameter. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em Terminating}]TRUE if derived class is terminating (destructor) \end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]- \end{Desc}
\index{CTCPIPCommSend@{CTCPIPComm\-Send}!Terminating@{Terminating}}
\index{Terminating@{Terminating}!CTCPIPCommSend@{CTCPIPComm\-Send}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool CTCPIPComm\-Send::Terminating (void) const\hspace{0.3cm}{\tt  [inline]}}\label{classCTCPIPCommSend_a5}


Terminating (get state) Returns the state whether the class is terminating (destructor) or not. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em -}]\end{description}
\end{Desc}
\begin{Desc}
\item[R\"{u}ckgabe:]True if terminating \end{Desc}


Die Dokumentation f\"{u}r diese Klasse wurde erzeugt aufgrund der Dateien:\begin{CompactItemize}
\item 
TCPIPComm\-Send.h\item 
TCPIPComm\-Send.cpp\end{CompactItemize}
