BARANTMail/docs/latex/classmail_1_1_mail_delivery.tex

82 lines
4.6 KiB
TeX

\hypertarget{classmail_1_1_mail_delivery}{}\section{mail\+:\+:Mail\+Delivery Class Reference}
\label{classmail_1_1_mail_delivery}\index{mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}}
{\ttfamily \#include $<$Mail\+Delivery.\+h$>$}
Inheritance diagram for mail\+:\+:Mail\+Delivery\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=175pt]{classmail_1_1_mail_delivery__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for mail\+:\+:Mail\+Delivery\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=175pt]{classmail_1_1_mail_delivery__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{classmail_1_1_mail_delivery_af3d72e67ab8a701984a940a6941279dc}{Mail\+Delivery} (core\+::\+E\+Poll \&e\+Poll, std\+::string mail\+Queue)
\item
void \hyperlink{classmail_1_1_mail_delivery_a21ed86ff778060d313a8cfa473aa1a84}{on\+Data\+Received} (std\+::string data) override
\item
int \hyperlink{classmail_1_1_mail_delivery_aad5d5fe3bf80fd29951c4db4e12387ba}{start\+Delivery} (std\+::string mail\+Queue)
\item
int \hyperlink{classmail_1_1_mail_delivery_afc1c5082f187cb6d4a38e6a8073d736d}{deliver} ()
\item
std\+::string \hyperlink{classmail_1_1_mail_delivery_a3dfe36fe157b4ddbe28ba5dfd01f2848}{get\+Mail\+File\+Name} ()
\end{DoxyCompactItemize}
\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classmail_1_1_mail_delivery_af3d72e67ab8a701984a940a6941279dc}\label{classmail_1_1_mail_delivery_af3d72e67ab8a701984a940a6941279dc}}
\index{mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}!Mail\+Delivery@{Mail\+Delivery}}
\index{Mail\+Delivery@{Mail\+Delivery}!mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}}
\subsubsection{\texorpdfstring{Mail\+Delivery()}{MailDelivery()}}
{\footnotesize\ttfamily mail\+::\+Mail\+Delivery\+::\+Mail\+Delivery (\begin{DoxyParamCaption}\item[{core\+::\+E\+Poll \&}]{e\+Poll, }\item[{std\+::string}]{mail\+Queue }\end{DoxyParamCaption})}
\subsection{Member Function Documentation}
\mbox{\Hypertarget{classmail_1_1_mail_delivery_afc1c5082f187cb6d4a38e6a8073d736d}\label{classmail_1_1_mail_delivery_afc1c5082f187cb6d4a38e6a8073d736d}}
\index{mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}!deliver@{deliver}}
\index{deliver@{deliver}!mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}}
\subsubsection{\texorpdfstring{deliver()}{deliver()}}
{\footnotesize\ttfamily int mail\+::\+Mail\+Delivery\+::deliver (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{classmail_1_1_mail_delivery_a3dfe36fe157b4ddbe28ba5dfd01f2848}\label{classmail_1_1_mail_delivery_a3dfe36fe157b4ddbe28ba5dfd01f2848}}
\index{mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}!get\+Mail\+File\+Name@{get\+Mail\+File\+Name}}
\index{get\+Mail\+File\+Name@{get\+Mail\+File\+Name}!mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}}
\subsubsection{\texorpdfstring{get\+Mail\+File\+Name()}{getMailFileName()}}
{\footnotesize\ttfamily std\+::string mail\+::\+Mail\+Delivery\+::get\+Mail\+File\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{classmail_1_1_mail_delivery_a21ed86ff778060d313a8cfa473aa1a84}\label{classmail_1_1_mail_delivery_a21ed86ff778060d313a8cfa473aa1a84}}
\index{mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}!on\+Data\+Received@{on\+Data\+Received}}
\index{on\+Data\+Received@{on\+Data\+Received}!mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}}
\subsubsection{\texorpdfstring{on\+Data\+Received()}{onDataReceived()}}
{\footnotesize\ttfamily void mail\+::\+Mail\+Delivery\+::on\+Data\+Received (\begin{DoxyParamCaption}\item[{std\+::string}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}}
\mbox{\Hypertarget{classmail_1_1_mail_delivery_aad5d5fe3bf80fd29951c4db4e12387ba}\label{classmail_1_1_mail_delivery_aad5d5fe3bf80fd29951c4db4e12387ba}}
\index{mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}!start\+Delivery@{start\+Delivery}}
\index{start\+Delivery@{start\+Delivery}!mail\+::\+Mail\+Delivery@{mail\+::\+Mail\+Delivery}}
\subsubsection{\texorpdfstring{start\+Delivery()}{startDelivery()}}
{\footnotesize\ttfamily int mail\+::\+Mail\+Delivery\+::start\+Delivery (\begin{DoxyParamCaption}\item[{std\+::string}]{mail\+Queue }\end{DoxyParamCaption})}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
/home/bradarant/barant/\+B\+M\+A\+Mail/\hyperlink{_mail_delivery_8h}{Mail\+Delivery.\+h}\item
/home/bradarant/barant/\+B\+M\+A\+Mail/\hyperlink{_mail_delivery_8cpp}{Mail\+Delivery.\+cpp}\end{DoxyCompactItemize}