From e1688d5731c5e27648a267250a467bf2dc823e39 Mon Sep 17 00:00:00 2001 From: Carlos Daniel Ruvalcaba Valenzuela Date: Fri, 21 Sep 2007 01:04:45 -0700 Subject: [PATCH] Updated IPC documentation --- docs/ipc.tex | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/docs/ipc.tex b/docs/ipc.tex index abdc663..1304a59 100644 --- a/docs/ipc.tex +++ b/docs/ipc.tex @@ -157,7 +157,32 @@ when there is new messages in the queue. \item IPC Callback String \end{paramlist} +\ipcmsg{unsuscribe} + +Remove subscription to a queue. The IPC Callback String should +be exactly the same as given on subscription. + +\begin{paramlist} +\item Queue Name +\item IPC Callback String +\end{paramlist} + \section{Mailbox Server} + +\subsection{Comunication Examples} + +\subsubsection{Listing a user mailbox} + +Give a mailbox server MS and a client C: + +\begin{verbatim} +C: list: user_john +MS: ok: 2 +MS: mailinfo: 1 ; 120 +MS: mailinfo: 2 ; 300 +MS: ok +\end{verbatim} + \subsection{Messages} \ipcmsg{list} @@ -167,7 +192,7 @@ for a given user, after that it will push n "mailinfo" message. On failture it will return error. \begin{paramlist} -\item username +\item Username \end{paramlist} \ipcmsg{mailinfo} @@ -175,8 +200,8 @@ message. On failture it will return error. Return message with a given email detail. \begin{paramlist} -\item Number -\item Size +\item Message Number +\item Message Size (in octets) \end{paramlist} \ipcmsg{store} @@ -200,8 +225,19 @@ start sending the email using raw operations. If the email number is invalid will return error. \begin{paramlist} -\item username -\item Number +\item Username +\item Message Number +\end{paramlist} + +\ipcmsg{dele} + +Delete an email for a given user. It will return +ok if the operation was sucessful, error otherwise +(when the message doesen't exist. + +\begin{paramlist} +\item Username +\item Message Number \end{paramlist} \end{document} -- 2.11.4.GIT