===================================================================
RCS file: /home/cvs/OpenXM/src/OpenMath/ORG/openxm/tam/OpenXM.java,v
retrieving revision 1.4
retrieving revision 1.8
diff -u -p -r1.4 -r1.8
--- OpenXM/src/OpenMath/ORG/openxm/tam/OpenXM.java 2000/09/13 06:32:43 1.4
+++ OpenXM/src/OpenMath/ORG/openxm/tam/OpenXM.java 2001/11/04 09:58:14 1.8
@@ -1,5 +1,5 @@
/**
- * $OpenXM: OpenXM/src/OpenMath/ORG/openxm/tam/OpenXM.java,v 1.3 2000/09/08 07:29:45 tam Exp $
+ * $OpenXM: OpenXM/src/OpenMath/ORG/openxm/tam/OpenXM.java,v 1.7 2001/11/01 08:54:50 takayama Exp $
*/
package ORG.openxm.tam;
@@ -7,20 +7,37 @@ import java.io.*;
import java.net.*;
+/*&ja
+ OpenXM サーバとの接続を行なうクラス.
+ クライアント側が使用する.
+ 接続するサーバ毎に一つの OpenXM クラスが必要.
+*/
/**
- * OpenXM サーバとの接続を行なうクラス.
- * クライアント側が使用する.
- * 接続するサーバ毎に一つの OpenXM クラスが必要.
+ * OpenXM is a class to connect to OpenXM servers,
+ * which are compliant to OpenXM RFC 100.
+ * There is one-to-one correspondence between the instances
+ * of the class OpenXM and the OpenXM servers.
*/
public class OpenXM{
private OpenXMstream control = null, stream = null;
final protected boolean debug = false;
- /**
+ /*&ja
* OpenXM サーバとの接続を TCP/IP ソケットを用いて行なう.
* マシン名 host のポート番号 CtrlPort にコントロールを,
* ポート番号 StreamPort にデータ用の接続を行なう.
*/
+ /**
+ * Connect to an OpenXM server via TCP/IP socket.
+ * @param host a machine name of the OpenXM server.
+ * @param CtrlPort the control port number of the OpenXM server.
+ * @param StreamPort the data port number of the OpenXM server.
+ * As to details on the notion of control port and data port, see
+ * Design and Implementation of OpenXM client server model and
+ * common mathematical object format (OpenXM-RFC 100,
+ * proposed standard)
+ * @see OpenXM
+ */
public OpenXM(String host,int CtrlPort,int StreamPort) throws IOException{
control = new OpenXMstream(host,CtrlPort);
@@ -36,31 +53,74 @@ public class OpenXM{
stream.sendByteOrder();
}
+ /*&ja
+ * コマンド command を立ち上げ、
+ * OpenXM サーバとの接続を TCP/IP ソケットを用いて行なう.
+ * マシン名 host のポート番号 CtrlPort にコントロールを,
+ * ポート番号 StreamPort にデータ用の接続を行なう.
+ */
/**
+ * First, execute a command, which is usually an OpenXM server,
+ * and next try to connect to the OpenXM server via TCP/IP.
+ * @param command a command.
+ * @param host a machine name of the OpenXM server.
+ * @param CtrlPort the control port number of the OpenXM server.
+ * @param StreamPort the data port number of the OpenXM server.
+ */
+ public OpenXM(String command,String host,int CtrlPort,int StreamPort)
+ throws IOException{
+ Runtime.getRuntime().exec(command);
+ control = new OpenXMstream(host,CtrlPort);
+
+ try{
+ Thread.sleep(100); // We need a few wait for starting up server.
+ }catch(InterruptedException e){
+ System.err.println(e.getMessage());
+ }
+
+ stream = new OpenXMstream(host,StreamPort);
+
+ control.sendByteOrder();
+ stream.sendByteOrder();
+ }
+
+ /*&ja
* 接続の初期化を行なう. 現在は未実装.
*/
+ /**
+ * Resetting the engine process. It has not yet been implemented.
+ */
public synchronized void resetConnection(){
debug("control: stopping computer process...");
debug("control: sending SYNC BALL.");
}
- /**
+ /*&ja
* OpenXM メッセージをデータストリームに送信する.
* このメソッドはメッセージのボディの部分だけでよい.
* ヘッダ部分は自動で付加される.
*/
+ /**
+ * Send an OpenXM message object.
+ * @param object a message. For example, oxm.send(new CMO_STRING("Hello"))
+ * sends a string "Hello" to the OpenXM server oxm in the CMO_STRING data
+ * encoding.
+ */
public void send(OXbody object) throws IOException,MathcapViolation{
stream.send(object);
}
- /**
+ /*&ja
* データストリームから OpenXM メッセージを受け取る.
*/
+ /**
+ * Receive an OpenXM message.
+ */
public OXmessage receive() throws IOException{
return stream.receive();
}
- /**
+ /*&ja
* データストリームの MathCap を mathcap に設定する.
* 以後, 送信するオブジェクトは mathcap に合っているかどうか
* チェックが入る. 実際にチェックが入るかどうかは
@@ -68,6 +128,11 @@ public class OpenXM{
* mathcap に反したオブジェクトを送ろうとした時には,
* 以後 MathcapViolation が発生することが期待される.
*/
+ /**
+ * Set the mathcap.
+ * If one tries to send an object which is prohibited to send by the mathcap,
+ * the mathcapViolation exception is thrown.
+ */
public void setMathCap(CMO_MATHCAP mathcap){
stream.setMathCap(mathcap);
}
@@ -87,7 +152,7 @@ public class OpenXM{
for(int i=0;i