PSI sics-cvs-psi_pre-ansto

doc/programmer/servlog.tex

@@ -0,0 +1,22 @@
+\subsection{The Server Logfile}
+The SIVS server maintains a server log file. In this log file, all commands
+and answers are written as well as diagnostic messages from all parts of the
+system.In order to prevent the log files from growing to endless sizes they
+are limited in length. When one file is finished the next file is written.
+This happend for a predefined number of files. Then the first file is
+reused. This scheme is configured by defines in servlog.c.
+
+The interface to this module is simple:
+\begin{description}
+\item[void SICSLogWrite(char *ptext, OutCode eOut )] writes text with
+outcode eOut to the server log. The outcodes are the same as used for
+outpout through SCWrite in conman.h.
+\item[int LogCapture(SConnection *pCon, SicsInterp *pInter, void *pData,
+	               int argc, char *argv[])]
+ Wrapper function which allows the connection pCon to redirect output to the
+server log file to its socket. For details see the user documentation.
+\item[int KillCapture(SConnection *pCon)] This function is automatically
+called when a connection object dies. It releases all LogCapture entries for
+the connection.
+\end{description}
+