diff options
Diffstat (limited to 'doc/latex/classLog.tex')
| -rw-r--r-- | doc/latex/classLog.tex | 363 |
1 files changed, 363 insertions, 0 deletions
diff --git a/doc/latex/classLog.tex b/doc/latex/classLog.tex new file mode 100644 index 0000000..e5eb8e9 --- /dev/null +++ b/doc/latex/classLog.tex @@ -0,0 +1,363 @@ +\section{Log Class Reference} +\label{classLog}\index{Log@{Log}} +{\tt \#include $<$log.h$>$} + +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf Log} \& {\bf set\-Log\-Name} (std::string new\-Log\-Name) +\item +std::string {\bf get\-Log\-Name} () const +\item +{\bf Log} \& {\bf set\-Facility} (int new\-Facility) +\item +int {\bf get\-Facility} () const +\item +{\bf Log\-String\-Builder} {\bf msg} (int prio={\bf PRIO\_\-INFO}) +\end{CompactItemize} +\subsection*{Static Public Member Functions} +\begin{CompactItemize} +\item +static {\bf Log} \& {\bf instance} () +\end{CompactItemize} +\subsection*{Static Public Attributes} +\begin{CompactItemize} +\item +static const int {\bf FAC\_\-USER} = LOG\_\-USER +\item +static const int {\bf FAC\_\-MAIL} = LOG\_\-MAIL +\item +static const int {\bf FAC\_\-DAEMON} = LOG\_\-DAEMON +\item +static const int {\bf FAC\_\-AUTH} = LOG\_\-AUTH +\item +static const int {\bf FAC\_\-SYSLOG} = LOG\_\-SYSLOG +\item +static const int {\bf FAC\_\-LPR} = LOG\_\-LPR +\item +static const int {\bf FAC\_\-NEWS} = LOG\_\-NEWS +\item +static const int {\bf FAC\_\-UUCP} = LOG\_\-UUCP +\item +static const int {\bf FAC\_\-CRON} = LOG\_\-CRON +\item +static const int {\bf FAC\_\-AUTHPRIV} = LOG\_\-AUTHPRIV +\item +static const int {\bf FAC\_\-FTP} = LOG\_\-FTP +\item +static const int {\bf FAC\_\-LOCAL0} = LOG\_\-LOCAL0 +\item +static const int {\bf FAC\_\-LOCAL1} = LOG\_\-LOCAL1 +\item +static const int {\bf FAC\_\-LOCAL2} = LOG\_\-LOCAL2 +\item +static const int {\bf FAC\_\-LOCAL3} = LOG\_\-LOCAL3 +\item +static const int {\bf FAC\_\-LOCAL4} = LOG\_\-LOCAL4 +\item +static const int {\bf FAC\_\-LOCAL5} = LOG\_\-LOCAL5 +\item +static const int {\bf FAC\_\-LOCAL6} = LOG\_\-LOCAL6 +\item +static const int {\bf FAC\_\-LOCAL7} = LOG\_\-LOCAL7 +\item +static const int {\bf PRIO\_\-EMERG} = LOG\_\-EMERG +\item +static const int {\bf PRIO\_\-ALERT} = LOG\_\-ALERT +\item +static const int {\bf PRIO\_\-CRIT} = LOG\_\-CRIT +\item +static const int {\bf PRIO\_\-ERR} = LOG\_\-ERR +\item +static const int {\bf PRIO\_\-WARNING} = LOG\_\-WARNING +\item +static const int {\bf PRIO\_\-NOTICE} = LOG\_\-NOTICE +\item +static const int {\bf PRIO\_\-INFO} = LOG\_\-INFO +\item +static const int {\bf PRIO\_\-DEBUG} = LOG\_\-DEBUG +\end{CompactItemize} +\subsection*{Private Member Functions} +\begin{CompactItemize} +\item +{\bf Log} () +\item +{\bf $\sim$Log} () +\item +{\bf Log} (const {\bf Log} \&l) +\item +void {\bf operator=} (const {\bf Log} \&l) +\item +void {\bf open} () +\end{CompactItemize} +\subsection*{Private Attributes} +\begin{CompactItemize} +\item +{\bf Mutex} {\bf mutex} +\item +std::string {\bf log\-Name} +\item +int {\bf facility} +\end{CompactItemize} +\subsection*{Static Private Attributes} +\begin{CompactItemize} +\item +static {\bf Log} $\ast$ {\bf inst} +\item +static {\bf Mutex} {\bf inst\-Mutex} +\end{CompactItemize} +\subsection*{Friends} +\begin{CompactItemize} +\item +class {\bf instance\-Cleaner} +\item +class {\bf Log\-String\-Builder} +\end{CompactItemize} +\subsection*{Classes} +\begin{CompactItemize} +\item +class {\bf instance\-Cleaner} +\end{CompactItemize} + + +\subsection{Constructor \& Destructor Documentation} +\index{Log@{Log}!Log@{Log}} +\index{Log@{Log}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Log::Log ()\hspace{0.3cm}{\tt [private]}}\label{classLog_f6071a60aa52b6c1b511f99b4bc1b8fe} + + +\index{Log@{Log}!~Log@{$\sim$Log}} +\index{~Log@{$\sim$Log}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Log::$\sim$Log ()\hspace{0.3cm}{\tt [private]}}\label{classLog_0fbfda88fbee5027c89f6eb121059360} + + +\index{Log@{Log}!Log@{Log}} +\index{Log@{Log}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Log::Log (const {\bf Log} \& {\em l})\hspace{0.3cm}{\tt [private]}}\label{classLog_756aec21ec377fbc703f787e7f5fb832} + + + + +\subsection{Member Function Documentation} +\index{Log@{Log}!instance@{instance}} +\index{instance@{instance}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Log} \& Log::instance ()\hspace{0.3cm}{\tt [static]}}\label{classLog_aa59866ce9e78db15ce7aaeb00fc1063} + + +\index{Log@{Log}!setLogName@{setLogName}} +\index{setLogName@{setLogName}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Log} \& Log::set\-Log\-Name (std::string {\em new\-Log\-Name})}\label{classLog_f8cf0541a8284aabd5fe924a9cd2eab8} + + +\index{Log@{Log}!getLogName@{getLogName}} +\index{getLogName@{getLogName}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string Log::get\-Log\-Name () const\hspace{0.3cm}{\tt [inline]}}\label{classLog_9090c0fbbc5a3223dbd361a827788c17} + + +\index{Log@{Log}!setFacility@{setFacility}} +\index{setFacility@{setFacility}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Log} \& Log::set\-Facility (int {\em new\-Facility})}\label{classLog_828e15ec0e9108b9fc43d74da77a902c} + + +\index{Log@{Log}!getFacility@{getFacility}} +\index{getFacility@{getFacility}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Log::get\-Facility () const\hspace{0.3cm}{\tt [inline]}}\label{classLog_238b6e5d47bb83307737f0c809fad669} + + +\index{Log@{Log}!msg@{msg}} +\index{msg@{msg}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Log\-String\-Builder} Log::msg (int {\em prio} = {\tt {\bf PRIO\_\-INFO}})\hspace{0.3cm}{\tt [inline]}}\label{classLog_7077dc047eb915d2fae46e36f5040f85} + + +\index{Log@{Log}!operator=@{operator=}} +\index{operator=@{operator=}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Log::operator= (const {\bf Log} \& {\em l})\hspace{0.3cm}{\tt [private]}}\label{classLog_076b147c2bc9b2167074e9bc51a24af7} + + +\index{Log@{Log}!open@{open}} +\index{open@{open}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Log::open ()\hspace{0.3cm}{\tt [private]}}\label{classLog_f91976ebadd955414799131cb442d24c} + + + + +\subsection{Friends And Related Function Documentation} +\index{Log@{Log}!instanceCleaner@{instanceCleaner}} +\index{instanceCleaner@{instanceCleaner}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class {\bf instance\-Cleaner}\hspace{0.3cm}{\tt [friend]}}\label{classLog_321cfbf9f58ebf3c9366bd6e0b5c18ce} + + +\index{Log@{Log}!LogStringBuilder@{LogStringBuilder}} +\index{LogStringBuilder@{LogStringBuilder}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class {\bf Log\-String\-Builder}\hspace{0.3cm}{\tt [friend]}}\label{classLog_16ded253dbe65c503d1d853dcf5460d6} + + + + +\subsection{Member Data Documentation} +\index{Log@{Log}!FAC_USER@{FAC\_\-USER}} +\index{FAC_USER@{FAC\_\-USER}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-USER} = LOG\_\-USER\hspace{0.3cm}{\tt [static]}}\label{classLog_9418bab5d66822411ce1f85823d8425b} + + +\index{Log@{Log}!FAC_MAIL@{FAC\_\-MAIL}} +\index{FAC_MAIL@{FAC\_\-MAIL}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-MAIL} = LOG\_\-MAIL\hspace{0.3cm}{\tt [static]}}\label{classLog_5cf4b465d8ecff58bd62ac064663917b} + + +\index{Log@{Log}!FAC_DAEMON@{FAC\_\-DAEMON}} +\index{FAC_DAEMON@{FAC\_\-DAEMON}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-DAEMON} = LOG\_\-DAEMON\hspace{0.3cm}{\tt [static]}}\label{classLog_6395030c0b8fa7f36b6fe0f6b837055d} + + +\index{Log@{Log}!FAC_AUTH@{FAC\_\-AUTH}} +\index{FAC_AUTH@{FAC\_\-AUTH}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-AUTH} = LOG\_\-AUTH\hspace{0.3cm}{\tt [static]}}\label{classLog_6f6fde7b6433d827c05cfefe16f9b333} + + +\index{Log@{Log}!FAC_SYSLOG@{FAC\_\-SYSLOG}} +\index{FAC_SYSLOG@{FAC\_\-SYSLOG}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-SYSLOG} = LOG\_\-SYSLOG\hspace{0.3cm}{\tt [static]}}\label{classLog_be74100156fee45add0417bc9f460f30} + + +\index{Log@{Log}!FAC_LPR@{FAC\_\-LPR}} +\index{FAC_LPR@{FAC\_\-LPR}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LPR} = LOG\_\-LPR\hspace{0.3cm}{\tt [static]}}\label{classLog_28a1239643de68f79ad6c2337acfd2ea} + + +\index{Log@{Log}!FAC_NEWS@{FAC\_\-NEWS}} +\index{FAC_NEWS@{FAC\_\-NEWS}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-NEWS} = LOG\_\-NEWS\hspace{0.3cm}{\tt [static]}}\label{classLog_b9f56520aeae70b9d98396f67ad1310b} + + +\index{Log@{Log}!FAC_UUCP@{FAC\_\-UUCP}} +\index{FAC_UUCP@{FAC\_\-UUCP}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-UUCP} = LOG\_\-UUCP\hspace{0.3cm}{\tt [static]}}\label{classLog_d5b2e5f3987835ec077013c6a263ed5f} + + +\index{Log@{Log}!FAC_CRON@{FAC\_\-CRON}} +\index{FAC_CRON@{FAC\_\-CRON}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-CRON} = LOG\_\-CRON\hspace{0.3cm}{\tt [static]}}\label{classLog_6a455dfca6d859f77ed79b6d92ad659a} + + +\index{Log@{Log}!FAC_AUTHPRIV@{FAC\_\-AUTHPRIV}} +\index{FAC_AUTHPRIV@{FAC\_\-AUTHPRIV}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-AUTHPRIV} = LOG\_\-AUTHPRIV\hspace{0.3cm}{\tt [static]}}\label{classLog_5245bb60b9c33e31027ea1f9a77d8053} + + +\index{Log@{Log}!FAC_FTP@{FAC\_\-FTP}} +\index{FAC_FTP@{FAC\_\-FTP}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-FTP} = LOG\_\-FTP\hspace{0.3cm}{\tt [static]}}\label{classLog_9b822438fee8c8a0f4bb56c0e4415c95} + + +\index{Log@{Log}!FAC_LOCAL0@{FAC\_\-LOCAL0}} +\index{FAC_LOCAL0@{FAC\_\-LOCAL0}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL0} = LOG\_\-LOCAL0\hspace{0.3cm}{\tt [static]}}\label{classLog_e6271aefc4c8749e602da64f284f0d08} + + +\index{Log@{Log}!FAC_LOCAL1@{FAC\_\-LOCAL1}} +\index{FAC_LOCAL1@{FAC\_\-LOCAL1}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL1} = LOG\_\-LOCAL1\hspace{0.3cm}{\tt [static]}}\label{classLog_b553df5af8dd47f2e9d29569b26b7713} + + +\index{Log@{Log}!FAC_LOCAL2@{FAC\_\-LOCAL2}} +\index{FAC_LOCAL2@{FAC\_\-LOCAL2}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL2} = LOG\_\-LOCAL2\hspace{0.3cm}{\tt [static]}}\label{classLog_1e79b43d3ed6f44281f1d6f4d6e2a829} + + +\index{Log@{Log}!FAC_LOCAL3@{FAC\_\-LOCAL3}} +\index{FAC_LOCAL3@{FAC\_\-LOCAL3}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL3} = LOG\_\-LOCAL3\hspace{0.3cm}{\tt [static]}}\label{classLog_467961bf9b0b73dd863a29e29642ed62} + + +\index{Log@{Log}!FAC_LOCAL4@{FAC\_\-LOCAL4}} +\index{FAC_LOCAL4@{FAC\_\-LOCAL4}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL4} = LOG\_\-LOCAL4\hspace{0.3cm}{\tt [static]}}\label{classLog_2dfec8266dc4bfd9f4a37a6a6a193724} + + +\index{Log@{Log}!FAC_LOCAL5@{FAC\_\-LOCAL5}} +\index{FAC_LOCAL5@{FAC\_\-LOCAL5}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL5} = LOG\_\-LOCAL5\hspace{0.3cm}{\tt [static]}}\label{classLog_8c8f287b845408f62e9971869764193d} + + +\index{Log@{Log}!FAC_LOCAL6@{FAC\_\-LOCAL6}} +\index{FAC_LOCAL6@{FAC\_\-LOCAL6}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL6} = LOG\_\-LOCAL6\hspace{0.3cm}{\tt [static]}}\label{classLog_c7c45c9e1daa96ecb60ff12064a3dc6e} + + +\index{Log@{Log}!FAC_LOCAL7@{FAC\_\-LOCAL7}} +\index{FAC_LOCAL7@{FAC\_\-LOCAL7}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::FAC\_\-LOCAL7} = LOG\_\-LOCAL7\hspace{0.3cm}{\tt [static]}}\label{classLog_886a44fb4cec033f0f7c028f530fe97c} + + +\index{Log@{Log}!PRIO_EMERG@{PRIO\_\-EMERG}} +\index{PRIO_EMERG@{PRIO\_\-EMERG}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-EMERG} = LOG\_\-EMERG\hspace{0.3cm}{\tt [static]}}\label{classLog_3b068a7b9c9a7bd3a42d519daea16564} + + +\index{Log@{Log}!PRIO_ALERT@{PRIO\_\-ALERT}} +\index{PRIO_ALERT@{PRIO\_\-ALERT}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-ALERT} = LOG\_\-ALERT\hspace{0.3cm}{\tt [static]}}\label{classLog_77741b4b68493a7b082f856c9a70cae6} + + +\index{Log@{Log}!PRIO_CRIT@{PRIO\_\-CRIT}} +\index{PRIO_CRIT@{PRIO\_\-CRIT}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-CRIT} = LOG\_\-CRIT\hspace{0.3cm}{\tt [static]}}\label{classLog_275d2db1310f0b9663ac1e048cadd389} + + +\index{Log@{Log}!PRIO_ERR@{PRIO\_\-ERR}} +\index{PRIO_ERR@{PRIO\_\-ERR}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-ERR} = LOG\_\-ERR\hspace{0.3cm}{\tt [static]}}\label{classLog_d3769cb6592629a056ffeaa4ce1f3d46} + + +\index{Log@{Log}!PRIO_WARNING@{PRIO\_\-WARNING}} +\index{PRIO_WARNING@{PRIO\_\-WARNING}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-WARNING} = LOG\_\-WARNING\hspace{0.3cm}{\tt [static]}}\label{classLog_ef36517c65a41f4cf69d4795ec84b4a2} + + +\index{Log@{Log}!PRIO_NOTICE@{PRIO\_\-NOTICE}} +\index{PRIO_NOTICE@{PRIO\_\-NOTICE}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-NOTICE} = LOG\_\-NOTICE\hspace{0.3cm}{\tt [static]}}\label{classLog_783504697beb7cc8905d0296704d62f2} + + +\index{Log@{Log}!PRIO_INFO@{PRIO\_\-INFO}} +\index{PRIO_INFO@{PRIO\_\-INFO}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-INFO} = LOG\_\-INFO\hspace{0.3cm}{\tt [static]}}\label{classLog_3c50bb6ae5eff66436d72a53c50b0f6b} + + +\index{Log@{Log}!PRIO_DEBUG@{PRIO\_\-DEBUG}} +\index{PRIO_DEBUG@{PRIO\_\-DEBUG}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf Log::PRIO\_\-DEBUG} = LOG\_\-DEBUG\hspace{0.3cm}{\tt [static]}}\label{classLog_f9aad3521e9eda1c156009188cc0674b} + + +\index{Log@{Log}!inst@{inst}} +\index{inst@{inst}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Log} $\ast$ {\bf Log::inst}\hspace{0.3cm}{\tt [static, private]}}\label{classLog_aebf3ec6bf45b97cc842d9d53a5a6c0a} + + +\index{Log@{Log}!instMutex@{instMutex}} +\index{instMutex@{instMutex}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Mutex} {\bf Log::inst\-Mutex}\hspace{0.3cm}{\tt [static, private]}}\label{classLog_c561e8206daad55b4aa4ac8808f35314} + + +\index{Log@{Log}!mutex@{mutex}} +\index{mutex@{mutex}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Mutex} {\bf Log::mutex}\hspace{0.3cm}{\tt [private]}}\label{classLog_d69b96c96c1b6aa0c3d67e07ca131e85} + + +\index{Log@{Log}!logName@{logName}} +\index{logName@{logName}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string {\bf Log::log\-Name}\hspace{0.3cm}{\tt [private]}}\label{classLog_8abf9fa58d7af501f25415eb37fd71a0} + + +\index{Log@{Log}!facility@{facility}} +\index{facility@{facility}!Log@{Log}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf Log::facility}\hspace{0.3cm}{\tt [private]}}\label{classLog_844dc5894a51dce933ae2109868652a0} + + + + +The documentation for this class was generated from the following files:\begin{CompactItemize} +\item +{\bf log.h}\item +{\bf log.cpp}\end{CompactItemize} |