version 1.5, 2000/01/15 06:26:06 |
version 1.10, 2000/01/17 01:24:27 |
|
|
% $OpenXM: OpenXM/doc/issac2000/openxm-clients.tex,v 1.4 2000/01/13 09:21:34 ohara Exp $ |
% $OpenXM: OpenXM/doc/issac2000/openxm-clients.tex,v 1.9 2000/01/17 00:48:06 takayama Exp $ |
|
|
\section{OpenXM Clients} |
\section{OpenXM Clients} |
|
|
\subsection{Risa/Asir} |
\subsection{Risa/Asir} |
|
|
Risa/Asir provides a launcher to invoke an OpenXM server and to set up the |
Risa/Asir provides a launcher to invoke an OpenXM server and to set up the |
communication between the server and itself. It also provides primitives |
communication between the server and itself. As a client, |
for communication as built-in functions. |
it provides many built-in functions for communication. |
|
|
\subsubsection{{\tt ox\_launch}} |
\subsubsection{Setting up servers} |
{\tt ox\_launch} is a general purpose launcher. This application |
{\tt ox\_launch} is a general purpose launcher. This application |
invokes a server and initiates the server-client communication |
invokes a server and sets up the server-client communication |
according to the protocol stated in Section \ref{launcher}, then |
according to the protocol stated in Section \ref{launcher}, then |
itself becomes a control server. |
itself becomes a control server. |
Several facilities related to {{\tt ox\_launch}} are provided |
Several facilities related to {{\tt ox\_launch}} are provided |
Line 20 of functions to execute the port generation, {\tt bind |
|
Line 20 of functions to execute the port generation, {\tt bind |
|
{\tt connect} and {\tt accept} operations on sockets individually. |
{\tt connect} and {\tt accept} operations on sockets individually. |
|
|
\subsubsection{Manipulating servers} |
\subsubsection{Manipulating servers} |
|
Fundamental operations on OpenXM servers are |
Fundamental operations on OpenXM servers are sending and receiving |
exchange of {\tt OX} data and sending of {\tt SM} commands. |
of {\tt OX} data and sending of {\tt OX} commands. The following functions |
The following functions |
are provided to execute these primitive operations: |
are provided to execute these primitive operations: |
{\tt ox\_push\_cmo()} for pushing data to a server, |
{\tt ox\_push\_cmo()} for pushing data to a server, |
{\tt ox\_push\_cmd()} for sending an {\tt SM} command to a server |
{\tt ox\_push\_cmd()} for sending an {\tt SM} command to a server |
and {\tt ox\_get()} for receiving data from a stream. |
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 |
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} |
\begin{itemize} |
\item {\tt ox\_pop\_cmo()} |
\item {\tt ox\_pop\_cmo()} |
Line 41 it receives the data from the stream. |
|
Line 41 it receives the data from the stream. |
|
\item {\tt ox\_cmo\_rpc()} |
\item {\tt ox\_cmo\_rpc()} |
|
|
After pushing the name of a function, arguments and the number of the |
After pushing the name of a function, arguments and the number of the |
arguments to the stack of a server, it request the server to execute |
arguments to the stack of a server, it requests the server to execute |
the function. It does not wait the termination of the function call. |
the function. It does not wait the termination of the function call. |
|
|
\item {\tt ox\_reset()} |
\item {\tt ox\_reset()} |
Line 49 the function. It does not wait the termination of the |
|
Line 49 the function. It does not wait the termination of the |
|
After sending {\tt SM\_control\_reset\_connection} to a control server, |
After sending {\tt SM\_control\_reset\_connection} to a control server, |
it completes the operations stated in Section \ref{control}. |
it completes the operations stated in Section \ref{control}. |
\end{itemize} |
\end{itemize} |
Furthermore {\tt ox\_select()} is provided to detect streams ready for |
Furthermore {\tt ox\_select()} is provided to detect if streams are ready for |
reading. It is realized by the {\tt select()} system call and is used |
reading. It is implemented by the {\tt select()} system call and is used |
to avoid blocking on read operations. |
to avoid blocking on read operations. |
|
|
\subsection{Mathematica} |
\subsection{Mathematica} |
|
|
We provide an OpenXM client {\tt math2ox} written as an external module |
We provide an OpenXM client {\tt math2ox} written as an external module |
for Mathematica. Our client communicates to Mathematica by MathLink and |
for Mathematica. |
to an OpenXM server by OpenXM protocols. |
The module {\tt math2ox} communicates with Mathematica by MathLink and |
|
with any OpenXM server by the OpenXM protocol. |
By using the module {\tt math2ox}, |
By using the module {\tt math2ox}, |
we can call OpenXM servers from Mathematica; |
we can call OpenXM servers from Mathematica; |
here is an example of a computation of the de Rham cohomology groups |
here is a demonstration of a computation of the de Rham cohomology groups |
of ${\bf C}^2 \setminus V(x^3-y^2)$. |
of ${\bf C}^2 \setminus V(x^3-y^2)$ from Mathematica. |
{\footnotesize |
{\footnotesize |
\begin{verbatim} |
\begin{verbatim} |
In[1]:= Install["math2ox"] |
In[1]:= Install["math2ox"] |
In[2]:= OxStart["../lib/sm1/bin/ox_sm1_forAsir"] |
In[2]:= OxStart["../lib/sm1/bin/ox_sm1_forAsir"] |
In[3]:= OxExecute[" [(x^3-y^2) (x,y)] deRham "] |
In[3]:= OxExecute[" [(x^3-y^2) (x,y)] deRham "] |
In[4]:= OxPopString[] |
In[4]:= OxPopString[] |
Out[4]= [ 1 , 1 , 0 ] |
Out[4]= [ 1 , 1 , 0 ] (* The dimension of |
|
cohomology groups *) |
\end{verbatim} |
\end{verbatim} |
} |
} |
|
|
\subsubsection{Functions} |
The {\tt math2ox} adds the following functions to Mathematica. |
|
|
The {\tt math2ox} has the following functions |
|
which respectively correspond those in Risa/Asir. |
|
\begin{quote} |
\begin{quote} |
{\tt OxStart[s\_String]} \\ |
{\tt OxStart[s\_String]} \\ |
{\tt OxStartInsecure[s\_String]} \\ |
{\tt OxStartInsecure[s\_String]} \\ |
Line 87 which respectively correspond those in Risa/Asir. |
|
Line 86 which respectively correspond those in Risa/Asir. |
|
{\tt OxClose[]} \\ |
{\tt OxClose[]} \\ |
{\tt OxReset[]} |
{\tt OxReset[]} |
\end{quote} |
\end{quote} |
For example, the {\tt OxPopCMO[]} function above requests a server to |
Although the list of functions speaks itself, |
send data on the stack to the stream, then it receives the data from the |
we add some explanations. |
stream. |
The function {\tt OxPopCMO[]} executes the same operation |
|
as {\tt ox\_pop\_cmo()} in Risa/Asir; |
By using the {\tt OxParse[]} function, we can send suitable OX messages, |
it pops data from the server stack. |
written by the OX expression, to a server. OX expressions are |
|
Lisp-like expressions for OX messages and are defined |
|
in~\cite{noro-takayama}. |
|
The {\tt OxGet[]} receives an OX data message |
The {\tt OxGet[]} receives an OX data message |
and returns its translation to an local object. |
and returns its translation to an local object. |
|
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}. |