Return to ox-messages.tex CVS log

Up to [local] / OpenXM / doc / ascm2001p

Annotation of OpenXM/doc/ascm2001p/ox-messages.tex, Revision 1.2

1.2     ! takayama    1: %%$OpenXM: OpenXM/doc/ascm2001p/ox-messages.tex,v 1.1 2001/06/19 07:32:58 noro Exp $
1.1       noro        2:
                      3: \section{OX messages}
                      4:
                      5: An OX message for TCP/IP is a byte stream consisting of
1.2     ! takayama    6: a header and a body:
1.1       noro        7: \begin{tabular}{|c|c|}
                      8: \hline
                      9: Header & \hspace{10mm} Body \hspace{10mm} \\
                     10: \hline
1.2     ! takayama   11: \end{tabular}.
1.1       noro       12: The header consists of two signed 32 bit integers.
                     13: The first one is an OX tag
                     14: and the second one is a serial number of the OX message.
                     15: %Negative numbers are expressed by the two's complement.
                     16: %Several byte orders including the network byte order
                     17: %are allowed and the byte order is determined as a part of
                     18: %the establishment of a connection. See Section \ref{secsession} for details.
                     19: The OX messages are classified into three types:
                     20: DATA, COMMAND, and SPECIAL.
                     21: %We have currently the following general tags for the OX messages:
                     22: Typical OX tags are
                     23: \verb+OX_COMMAND+ (COMMAND), \verb+OX_DATA+ (DATA) and \verb+OX_SYNC_BALL+ (SPECIAL).
                     24:
                     25: %\begin{verbatim}
                     26: %#define       OX_COMMAND               513  // COMMAND
                     27: %#define       OX_DATA                  514  // DATA
                     28: %#define OX_SYNC_BALL             515  // SPECIAL
                     29: %#define OX_DATA_WITH_LENGTH      521  // DATA
                     30: %#define OX_DATA_OPENMATH_XML     523  // DATA
                     31: %#define OX_DATA_OPENMATH_BINARY  524  // DATA
                     32: %#define OX_DATA_MP               525  // DATA
                     33: %\end{verbatim}
                     34:
                     35: %A new OX tag may be added.
                     36: %The new tag should be classified into DATA or COMMAND.
                     37: %For example, \verb+ OX_DATA_ASIR_LOCAL_BINARY +  was added recently
                     38: %to send internal serialized objects of Asir via the OpenXM protocol.
                     39: %This is a tag classified to DATA.
                     40: %See the web page of OpenXM to add a new tag \cite{openxm-web}.
                     41:
                     42: %An OpenXM client admit that its own command sends some OX messages
                     43: %sequentially at once.
                     44: %
                     45: %For example, the asir command
                     46: %{\tt ox\_execute\_string(P, "Print[x+y]")} sends an OX data message
                     47: %{\tt (OX\_DATA, (CMO\_STRING, "Print[x+y]"))} and an OX command message
                     48: %{\tt (OX\_COMMAND, (SM\_executeStringByLocalParser))} to an OpenXM
                     49: %server.