ServerCore/latex/classcore_1_1TLSServer.tex
2022-04-11 09:08:53 -07:00

84 lines
3.5 KiB
TeX

\hypertarget{classcore_1_1TLSServer}{}\doxysection{core\+::TLSServer Class Reference}
\label{classcore_1_1TLSServer}\index{core::TLSServer@{core::TLSServer}}
{\ttfamily \#include $<$TLSServer.\+h$>$}
Inheritance diagram for core\+::TLSServer\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=288pt]{classcore_1_1TLSServer__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for core\+::TLSServer\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classcore_1_1TLSServer__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}{TLSServer}} (\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&e\+Poll, \mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}} address)
\item
\mbox{\hyperlink{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}{$\sim$\+TLSServer}} ()
\item
\mbox{\Hypertarget{classcore_1_1TLSServer_a984dfd9faaa792e29f905e860d2e4a9e}\label{classcore_1_1TLSServer_a984dfd9faaa792e29f905e860d2e4a9e}}
\mbox{\hyperlink{classcore_1_1TCPSession}{TCPSession}} $\ast$ {\bfseries get\+Socket\+Accept} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classcore_1_1TLSServer_ab4e788350bda508fa44604d146e7537f}\label{classcore_1_1TLSServer_ab4e788350bda508fa44604d146e7537f}}
SSL\+\_\+\+CTX $\ast$ {\bfseries ctx}
\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}
\doxysubsection{Detailed Description}
\mbox{\hyperlink{classcore_1_1TLSServer}{TLSServer}}
Manage a socket connection as a TLS server type. Connections to the socket are processed through the accept functionality.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}\label{classcore_1_1TLSServer_a6460f9872936015efdfd0b8de04aa2fe}}
\index{core::TLSServer@{core::TLSServer}!TLSServer@{TLSServer}}
\index{TLSServer@{TLSServer}!core::TLSServer@{core::TLSServer}}
\doxysubsubsection{\texorpdfstring{TLSServer()}{TLSServer()}}
{\footnotesize\ttfamily core\+::\+TLSServer\+::\+TLSServer (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classcore_1_1EPoll}{EPoll}} \&}]{e\+Poll, }\item[{\mbox{\hyperlink{classcore_1_1IPAddress}{IPAddress}}}]{address }\end{DoxyParamCaption})}
The constructor.
\begin{DoxyParams}{Parameters}
{\em e\+Poll} & the BMAEPoll instance that manages the socket. \\
\hline
{\em url} & the IP address for the socket to receive connection requests. \\
\hline
{\em port} & the port number that the socket will listen on. \\
\hline
{\em command\+Name} & the name of the command used to invoke the status display for this object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the instance of the BMATLSServer\+Socket.
\end{DoxyReturn}
\mbox{\Hypertarget{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}\label{classcore_1_1TLSServer_ac71db77c796a1bf65357409cb96054c7}}
\index{core::TLSServer@{core::TLSServer}!````~TLSServer@{$\sim$TLSServer}}
\index{````~TLSServer@{$\sim$TLSServer}!core::TLSServer@{core::TLSServer}}
\doxysubsubsection{\texorpdfstring{$\sim$TLSServer()}{~TLSServer()}}
{\footnotesize\ttfamily core\+::\+TLSServer\+::$\sim$\+TLSServer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
The destructor for this object.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
TLSServer.\+h\item
TLSServer.\+cpp\end{DoxyCompactItemize}