=================================================================== RCS file: /home/cvs/OpenXM/doc/issac2000/openxm-clients.tex,v retrieving revision 1.8 retrieving revision 1.12 diff -u -p -r1.8 -r1.12 --- OpenXM/doc/issac2000/openxm-clients.tex 2000/01/16 10:58:19 1.8 +++ OpenXM/doc/issac2000/openxm-clients.tex 2000/01/17 07:15:52 1.12 @@ -1,36 +1,23 @@ -% $OpenXM: OpenXM/doc/issac2000/openxm-clients.tex,v 1.7 2000/01/16 06:39:39 takayama Exp $ +% $OpenXM: OpenXM/doc/issac2000/openxm-clients.tex,v 1.11 2000/01/17 06:10:40 noro Exp $ \section{OpenXM Clients} \subsection{Risa/Asir} -Risa/Asir provides a launcher to invoke an OpenXM server and to set up the -communication between the server and itself. As a client, -it provides many built-in functions for communication. - -\subsubsection{Setting up servers} -{\tt ox\_launch} is a general purpose launcher. This application -invokes a server and sets up the server-client communication -according to the protocol stated in Section \ref{launcher}, then -itself becomes a control server. -Several facilities related to {{\tt ox\_launch}} are provided -as built-in functions of Risa/Asir: a function to invoke a server -automatically from a give host name and a server name, and a set -of functions to execute the port generation, {\tt bind}, {\tt listen}, -{\tt connect} and {\tt accept} operations on sockets individually. - -\subsubsection{Manipulating servers} +Risa/Asir provides a launcher {\tt ox\_launch} +to invoke an OpenXM server and to set up the +communication between the server and itself. Fundamental operations on OpenXM servers are -exchange of {\tt OX} data and sending of {\tt SM} commands. -The following functions -are provided to execute these primitive operations: -{\tt ox\_push\_cmo()} for pushing data to a server, -{\tt ox\_push\_cmd()} for sending an {\tt SM} command to a server +exchange of OX data and sending of stack machine commands. +As a client, Asir provides the following functions +to execute these primitive operations: +{\tt ox\_push\_cmo()} for pushing data, +{\tt ox\_push\_cmd()} for sending a stack machine command and {\tt ox\_get()} for receiving data from a stream. -Some operations including the reset operation are realized by +Some operations including the reset operation are implemented by combining these primitives. Among them, frequently used ones are -provided as built-in functions. We show several ones. +provided as built-in functions. We show some of them. \begin{itemize} \item {\tt ox\_pop\_cmo()} @@ -49,8 +36,8 @@ the function. It does not wait the termination of the After sending {\tt SM\_control\_reset\_connection} to a control server, it completes the operations stated in Section \ref{control}. \end{itemize} -Furthermore {\tt ox\_select()} is provided to detect streams ready for -reading. It is realized by the {\tt select()} system call and is used +Furthermore {\tt ox\_select()} is provided to detect if streams are ready for +reading. It is implemented by the {\tt select()} system call and is used to avoid blocking on read operations. \subsection{Mathematica} @@ -93,7 +80,9 @@ as {\tt ox\_pop\_cmo()} in Risa/Asir; it pops data from the server stack. The {\tt OxGet[]} receives an OX data message and returns its translation to an local object. -By using the {\tt OxParse[]} function, one can send OX messages, +The function {\tt OxParse[]} helps debugging to connect Mathematica +and ox servers. +By using the function, one can send OX messages, written by the OX expression, to a server. OX expressions are Lisp-like expressions for OX messages and are defined in~\cite{noro-takayama}.