OSSP CVS Repository

ossp - Check-in [4287]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 4287
Date: 2001-Aug-07 16:41:06 (local)
2001-Aug-07 14:41:06 (UTC)
User:simons
Branch:
Comment: Documented the XDR and XML callbacks in tabular form.
Tickets:
Inspections:
Files:
ossp-pkg/xds/docs/libxds.tex      1.2 -> 1.3     39 inserted, 2 deleted

ossp-pkg/xds/docs/libxds.tex 1.2 -> 1.3

--- libxds.tex   2001/08/07 14:07:25     1.2
+++ libxds.tex   2001/08/07 14:41:06     1.3
@@ -1,6 +1,6 @@
 % -*- mode: LaTeX; fill-column: 75; -*-
 %
-% $Id: libxds.tex,v 1.2 2001/08/07 14:07:25 simons Exp $
+% $Id: libxds.tex,v 1.3 2001/08/07 14:41:06 simons Exp $
 %
 \documentclass[a4paper,10pt,pointlessnumbers,bibtotoc]{scrartcl}
 \usepackage[dvips,xdvi]{graphicx}
@@ -766,7 +766,6 @@
 the buffer, but we don't have that much data left), or
 \textsf{XDS\_ERR\_UNKNOWN} (an engine returned an unspecified error).
 
-
 \subsection{int xds\_decode(xds\_t*~\underline{xds}, const~char*~\underline{fmt}, \dots{});}
 
 This routine is basically identical to xds\_vdecode(), only that it uses a
@@ -775,9 +774,47 @@
 \section{The XDR Engines}
 \label{xdr}
 
+\begin{tabular}{|c|c|c|c|} \hline
+\bf Function Name     & \bf Expected ``args'' Data Type & \bf Input Size & \bf Output Size \\ \hline
+xdr\_encode\_uint32()      & xds\_uint32\_t   & 4 byte   & 4 byte \\
+xdr\_decode\_uint32()      & xds\_uint32\_t*  & 4 byte   & 4 byte \\[1ex]
+xdr\_encode\_int32()       & xds\_int32\_t    & 4 byte   & 4 byte \\
+xdr\_decode\_int32()       & xds\_int32\_t*   & 4 byte   & 4 byte \\[1ex]
+xdr\_encode\_uint64()      & xds\_uint64\_t   & 4 byte   & 4 byte \\
+xdr\_decode\_uint64()      & xds\_uint64\_t*  & 4 byte   & 4 byte \\[1ex]
+xdr\_encode\_int64()       & xds\_int64\_t    & 4 byte   & 4 byte \\
+xdr\_decode\_int64()       & xds\_int64\_t*   & 4 byte   & 4 byte \\[1ex]
+xdr\_encode\_double()      & xds\_double\_t   & ?? byte  & ?? byte \\
+xdr\_decode\_double()      & xds\_double\_t*  & ?? byte  & ?? byte \\[1ex]
+xdr\_encode\_octetstream() & void*, size\_t   & variable & variable \\
+xdr\_decode\_octetstream() & void**, size\_t* & variable & variable \\[1ex]
+xdr\_encode\_string()      & char*            & variable & variable \\
+xdr\_decode\_string()      & char**           & variable & variable \\ \hline
+\end{tabular}
+
 \section{The XML Engines}
 \label{xml}
 
+\subsection{Encoding engines}
+
+\begin{tabular}{|c|c|c|c|} \hline
+\bf Function Name     & \bf Expected ``args'' Data Type & \bf Input Size & \bf Output Size \\ \hline
+xml\_encode\_uint32()      & xds\_uint32\_t   & ?? byte  & ?? byte \\
+xml\_decode\_uint32()      & xds\_uint32\_t*  & ?? byte  & ?? byte \\[1ex]
+xml\_encode\_int32()       & xds\_int32\_t    & ?? byte  & ?? byte \\
+xml\_decode\_int32()       & xds\_int32\_t*   & ?? byte  & ?? byte \\[1ex]
+xml\_encode\_uint64()      & xds\_uint64\_t   & ?? byte  & ?? byte \\
+xml\_decode\_uint64()      & xds\_uint64\_t*  & ?? byte  & ?? byte \\[1ex]
+xml\_encode\_int64()       & xds\_int64\_t    & ?? byte  & ?? byte \\
+xml\_decode\_int64()       & xds\_int64\_t*   & ?? byte  & ?? byte \\[1ex]
+xml\_encode\_double()      & xds\_double\_t   & ?? byte  & ?? byte \\
+xml\_decode\_double()      & xds\_double\_t*  & ?? byte  & ?? byte \\[1ex]
+xml\_encode\_octetstream() & void*, size\_t   & variable & variable \\
+xml\_decode\_octetstream() & void**, size\_t* & variable & variable \\[1ex]
+xml\_encode\_string()      & char*            & variable & variable \\
+xml\_decode\_string()      & char**           & variable & variable \\ \hline
+\end{tabular}
+
 \newpage
 \begin{thebibliography}{xxx}
 

CVSTrac 2.0.1