mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-24 15:20:02 +02:00
e2f9d69677
git-svn-id: file:///afs/psi.ch/project/sls_det_software/svn/slsDetectorSoftware@1 951219d9-93cf-4727-9268-0efd64621fa3
187 lines
9.3 KiB
TeX
187 lines
9.3 KiB
TeX
\section{My\-Socket\-TCP Class Reference}
|
|
\label{classMySocketTCP}\index{MySocketTCP@{MySocketTCP}}
|
|
{\tt \#include $<$My\-Socket\-TCP.h$>$}
|
|
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{My\-Socket\-TCP} (const char $\ast$const host\_\-ip\_\-or\_\-name, unsigned short int const port\_\-number)
|
|
\item
|
|
\bf{My\-Socket\-TCP} (unsigned short int const port\_\-number)
|
|
\item
|
|
\bf{$\sim$My\-Socket\-TCP} ()
|
|
\item
|
|
int \bf{get\-Hostname} (char $\ast$name)
|
|
\item
|
|
int \bf{get\-Port\-Number} ()
|
|
\item
|
|
int \bf{get\-Error\-Status} ()
|
|
\item
|
|
int \bf{Connect} ()
|
|
\item
|
|
void \bf{Disconnect} ()
|
|
\item
|
|
int \bf{Send\-Data} (void $\ast$buf, int length)
|
|
\item
|
|
int \bf{Receive\-Data} (void $\ast$buf, int length)
|
|
\item
|
|
int \bf{Send\-Data\-And\-Keep\-Connection} (void $\ast$buf, int length)
|
|
\item
|
|
int \bf{Receive\-Data\-And\-Keep\-Connection} (void $\ast$buf, int length)
|
|
\item
|
|
int \bf{Send\-Data\-Only} (void $\ast$buf, int length)
|
|
\item
|
|
int \bf{Receive\-Data\-Only} (void $\ast$buf, int length)
|
|
\end{CompactItemize}
|
|
\subsection*{Private Attributes}
|
|
\begin{CompactItemize}
|
|
\item
|
|
char \bf{hostname} [1000]
|
|
\item
|
|
int \bf{portno}
|
|
\item
|
|
int \bf{is\_\-a\_\-server}
|
|
\item
|
|
int \bf{socket\-Descriptor}
|
|
\item
|
|
sockaddr\_\-in client\-Address \bf{server\-Address}
|
|
\item
|
|
socklen\_\-t \bf{client\-Address\_\-length}
|
|
\item
|
|
int \bf{file\_\-des}
|
|
\item
|
|
int \bf{send\_\-rec\_\-max\_\-size}
|
|
\item
|
|
bool \bf{last\_\-keep\_\-connection\_\-open\_\-action\_\-was\_\-a\_\-send}
|
|
\end{CompactItemize}
|
|
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!MySocketTCP@{MySocketTCP}}
|
|
\index{MySocketTCP@{MySocketTCP}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}My\-Socket\-TCP::My\-Socket\-TCP (const char $\ast$const {\em host\_\-ip\_\-or\_\-name}, unsigned short int const {\em port\_\-number})}\label{classMySocketTCP_4d44c3d3d93c2990bcdff6a58016a170}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!MySocketTCP@{MySocketTCP}}
|
|
\index{MySocketTCP@{MySocketTCP}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}My\-Socket\-TCP::My\-Socket\-TCP (unsigned short int const {\em port\_\-number})}\label{classMySocketTCP_1033d3d7438fe9da3cff3da3c4344c51}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!~MySocketTCP@{$\sim$MySocketTCP}}
|
|
\index{~MySocketTCP@{$\sim$MySocketTCP}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}My\-Socket\-TCP::$\sim$My\-Socket\-TCP ()}\label{classMySocketTCP_20407e0c509b8e32e164f1780b98b51c}
|
|
|
|
|
|
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!Connect@{Connect}}
|
|
\index{Connect@{Connect}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Connect ()}\label{classMySocketTCP_1debe73787357c6dcec52ca981298609}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!Disconnect@{Disconnect}}
|
|
\index{Disconnect@{Disconnect}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void My\-Socket\-TCP::Disconnect ()}\label{classMySocketTCP_69f0b72663378245f14e2872b92696a4}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!getErrorStatus@{getErrorStatus}}
|
|
\index{getErrorStatus@{getErrorStatus}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::get\-Error\-Status ()\hspace{0.3cm}{\tt [inline]}}\label{classMySocketTCP_8cd662e945f4a51e9f616fd5c196bdeb}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!getHostname@{getHostname}}
|
|
\index{getHostname@{getHostname}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::get\-Hostname (char $\ast$ {\em name})}\label{classMySocketTCP_6c3f62f34cf58c78d58bcc788776afa5}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!getPortNumber@{getPortNumber}}
|
|
\index{getPortNumber@{getPortNumber}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::get\-Port\-Number ()\hspace{0.3cm}{\tt [inline]}}\label{classMySocketTCP_8d15a71679ab2f83822db875be1ad5cd}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!ReceiveData@{ReceiveData}}
|
|
\index{ReceiveData@{ReceiveData}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Receive\-Data (void $\ast$ {\em buf}, int {\em length})}\label{classMySocketTCP_ed8a6a9435932659ed8793ff57b356c8}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!ReceiveDataAndKeepConnection@{ReceiveDataAndKeepConnection}}
|
|
\index{ReceiveDataAndKeepConnection@{ReceiveDataAndKeepConnection}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Receive\-Data\-And\-Keep\-Connection (void $\ast$ {\em buf}, int {\em length})}\label{classMySocketTCP_375171791400d7d60804b56852ff3611}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!ReceiveDataOnly@{ReceiveDataOnly}}
|
|
\index{ReceiveDataOnly@{ReceiveDataOnly}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Receive\-Data\-Only (void $\ast$ {\em buf}, int {\em length})}\label{classMySocketTCP_a8b6322845e72ffc6da44db774b19d73}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!SendData@{SendData}}
|
|
\index{SendData@{SendData}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Send\-Data (void $\ast$ {\em buf}, int {\em length})}\label{classMySocketTCP_7777e909e20c47d38e32a174b0eae425}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!SendDataAndKeepConnection@{SendDataAndKeepConnection}}
|
|
\index{SendDataAndKeepConnection@{SendDataAndKeepConnection}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Send\-Data\-And\-Keep\-Connection (void $\ast$ {\em buf}, int {\em length})}\label{classMySocketTCP_1641bc23538af6849efeb195a1b33626}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!SendDataOnly@{SendDataOnly}}
|
|
\index{SendDataOnly@{SendDataOnly}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int My\-Socket\-TCP::Send\-Data\-Only (void $\ast$ {\em buf}, int {\em length})}\label{classMySocketTCP_2f9ce7233ee4903127039d43b4a34886}
|
|
|
|
|
|
|
|
|
|
\subsection{Member Data Documentation}
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!clientAddress_length@{clientAddress\_\-length}}
|
|
\index{clientAddress_length@{clientAddress\_\-length}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}socklen\_\-t \bf{My\-Socket\-TCP::client\-Address\_\-length}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_446008276e7be89c50bd78f9a3015a69}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!file_des@{file\_\-des}}
|
|
\index{file_des@{file\_\-des}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int \bf{My\-Socket\-TCP::file\_\-des}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_8a6787a3cdb6b4539184b92303958f30}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!hostname@{hostname}}
|
|
\index{hostname@{hostname}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char \bf{My\-Socket\-TCP::hostname}[1000]\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_bfd6f681b235f233d3203336a89d58f2}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!is_a_server@{is\_\-a\_\-server}}
|
|
\index{is_a_server@{is\_\-a\_\-server}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int \bf{My\-Socket\-TCP::is\_\-a\_\-server}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_e95406b86fb4f0e1978c49f0ac9d3821}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!last_keep_connection_open_action_was_a_send@{last\_\-keep\_\-connection\_\-open\_\-action\_\-was\_\-a\_\-send}}
|
|
\index{last_keep_connection_open_action_was_a_send@{last\_\-keep\_\-connection\_\-open\_\-action\_\-was\_\-a\_\-send}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool \bf{My\-Socket\-TCP::last\_\-keep\_\-connection\_\-open\_\-action\_\-was\_\-a\_\-send}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_e0cdfa6a0f0498c01d057ff5db10dca5}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!portno@{portno}}
|
|
\index{portno@{portno}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int \bf{My\-Socket\-TCP::portno}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_cc9182c599b55d4f081c31cb162d56f6}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!send_rec_max_size@{send\_\-rec\_\-max\_\-size}}
|
|
\index{send_rec_max_size@{send\_\-rec\_\-max\_\-size}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int \bf{My\-Socket\-TCP::send\_\-rec\_\-max\_\-size}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_702056a78e403d4931181d54e7263290}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!serverAddress@{serverAddress}}
|
|
\index{serverAddress@{serverAddress}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct sockaddr\_\-in client\-Address \bf{My\-Socket\-TCP::server\-Address}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_02c455c28f7aff0075c954c43715dad2}
|
|
|
|
|
|
\index{MySocketTCP@{My\-Socket\-TCP}!socketDescriptor@{socketDescriptor}}
|
|
\index{socketDescriptor@{socketDescriptor}!MySocketTCP@{My\-Socket\-TCP}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int \bf{My\-Socket\-TCP::socket\-Descriptor}\hspace{0.3cm}{\tt [private]}}\label{classMySocketTCP_7246bd46ad899956f39109e528da0567}
|
|
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files:\begin{CompactItemize}
|
|
\item
|
|
My\-Socket\-TCP/\bf{My\-Socket\-TCP.h}\item
|
|
My\-Socket\-TCP/\bf{My\-Socket\-TCP.cxx}\end{CompactItemize}
|