OpenXM/src/ox_toolkit/README - diff

Return to README CVS log

Up to [local] / OpenXM / src / ox_toolkit

Diff for /OpenXM/src/ox_toolkit/README between version 1.10 and 1.15

version 1.10, 2000/03/10 12:24:38

version 1.15, 2000/11/21 07:59:08

Line 1

# Author: 小原功任 @ 金沢大学理学部計算科学教室

# URI: http://omega.s.kanazawa-u.ac.jp/ohara/

# $OpenXM: OpenXM/src/ox_toolkit/README,v 1.9 2000/01/20 17:18:55 ohara Exp $

# $OpenXM: OpenXM/src/ox_toolkit/README,v 1.14 2000/11/20 17:59:34 ohara Exp $

/*&ja ox_toolkit ユーザガイド

Line 129 new_cmo_error2(cmo* ob);

/*&ja

3. 高水準 API

3. コネクション

OXFILE は OpenXM での通信路を表現するクラスである。このクラスのオブジェ

クトを明示的には生成しないこと。必ずコンストラクタを利用しなければなら

ない。これはクライアントとサーバで接続時の手順が異なることに由来する。

バイトオーダに関連した処理はこのクラスのメソッドで実現される。このクラ

スのメソッドとして次のものが用意されている。

3.1 コンストラクタ

OXFILE *oxf_connect_active(char *hostname, short port);

能動的に接続する場合のコンストラクタ。通常、サーバで利用する。

OXFILE *oxf_connect_passive(int listened);

受動的に接続するためのコンストラクタ。

内部で accept() を呼ぶので、listened には mysocketListen() の返した値が必要。

OXFILE *oxf_open(int fd);

インスタンスを生成するだけで、接続は行わない。すでにオープンされたファ

イルディスクリプタを fd に指定する。計算サーバでの利用を想定。

3.2 認証に関連したメソッド

int oxf_confirm_client(OXFILE *oxfp, char *passwd);

クライアント側での認証を行う。返り値が1のときに成功、0のときに失敗。

int oxf_confirm_server(OXFILE *oxfp, char *passwd);

サーバ側での認証を行う。常に成功する。

void oxf_determine_byteorder_client(OXFILE *oxfp);

void oxf_determine_byteorder_server(OXFILE *oxfp);

oxfp の指す通信路でのバイトオーダを決定し、oxfp のインスタンスを書き換える。

void oxf_setopt(OXFILE *oxfp, int mode);

oxfp の設定を行う。oxf_determine_byteorder_XXX() で用いられている。

3.3 その他のメソッド

int oxf_read(void *buffer, size_t size, size_t num, OXFILE *oxfp);

int oxf_write(void *buffer, size_t size, size_t num, OXFILE *oxfp);

void oxf_flush(OXFILE *oxfp);

void oxf_close(OXFILE *oxfp);

fread, fwrite, fflush, fclose に準拠。

/*&ja

4. 高水準 API(この記述は古いので使わないこと)

高水準 API は「OpenXM クライアント」から利用することを前提に設計されている。

3.1 通信の開始

4.1 通信の開始

通信を開始する場合には、次の関数のいずれかを利用する。

/*&en

3. High-level API

4. High-level API

High-level API is prepared to help an implementation of OpenXM clients.

3.1 How to make connections to OpenXM servers?

4.1 How to make connections to OpenXM servers?

In order to open a connection to an OpenXM server, you need to call

ox_start() or to call ox_start_insecure_nonreverse().

/*&common

ox_file_t ox_start(char* host, char* prog1, char* prog2);

OXFILE *ox_start(char* host, char* prog1, char* prog2);

ox_file_t ox_start_insecure_nonreverse(char* host, short portControl, short portStream);

OXFILE *ox_start_insecure_nonreverse(char* host, short portControl, short portStream);

/*&ja

Line 180 OpenXM server run on a remote host and you need to pro

Line 234 OpenXM server run on a remote host and you need to pro

/*&ja

3.2 通信の終了

4.2 通信の終了

通信の終了のためには次の二つの関数が用意されている。

/*&en

3.2 How to close connections to OpenXM servers?

4.2 How to close connections to OpenXM servers?

In order to close a connection to an OpenXM server, you need to call

ox_close() or to call ox_shutdown().

/*&common

void ox_close(ox_file_t sv);

void ox_close(OXFILE *sv);

void ox_shutdown(ox_file_t sv);

void ox_shutdown(OXFILE *sv);

/*&ja

Line 204 void ox_shutdown(ox_file_t sv);

Line 258 void ox_shutdown(ox_file_t sv);

/*&ja

3.3 SM コマンドの送信

4.3 SM コマンドの送信

/*&en

3.3 How to command to OpenXM stack machines?

4.3 How to command to OpenXM stack machines?

/*&common

void ox_push_cmd(ox_file_t sv, int sm_code);

void ox_push_cmd(OXFILE *sv, int sm_code);

/*&ja

Line 224 See OpenXM/include/ox_toolkit_tags.h for a list of ope

Line 278 See OpenXM/include/ox_toolkit_tags.h for a list of ope

/*&ja

3.4 CMO の送受信

4.4 CMO の送受信

/*&en

3.4 How to receive a CMO?

4.4 How to receive a CMO?

/*&common

void ox_push_cmo(ox_file_t sv, cmo *c);

void ox_push_cmo(OXFILE *sv, cmo *c);

cmo* ox_pop_cmo(ox_file_t sv);

cmo* ox_pop_cmo(OXFILE *sv);

char* ox_popString(ox_file_t sv);

char* ox_popString(OXFILE *sv);

/*&ja

Line 245 ox_push_cmo は cmo を送信、ox_pop_cmo は cmo を受信す�

Line 299 ox_push_cmo は cmo を送信、ox_pop_cmo は cmo を受信す�

/*&en

/*&ja

3.5 スタック処理

4.5 スタック処理

/*&common

int ox_pops(ox_file_t sv, int num);

int ox_pops(OXFILE *sv, int num);

/*&ja

Line 257 int ox_pops(ox_file_t sv, int num);

Line 311 int ox_pops(ox_file_t sv, int num);

/*&ja

3.6 通信路のフラッシュ

4.6 通信路のフラッシュ

/*&common

int ox_flush(ox_file_t sv);

int ox_flush(OXFILE *sv);

/*&ja

Line 269 int ox_flush(ox_file_t sv);

Line 323 int ox_flush(ox_file_t sv);

/*&ja

3.7 通信の中断

4.7 通信の中断

/*&common

void ox_reset(ox_file_t sv);

void ox_reset(OXFILE *sv);

/*&ja

Line 281 void ox_reset(ox_file_t sv);

Line 335 void ox_reset(ox_file_t sv);

/*&ja

3.8 ローカル言語で書かれたコマンドの評価

4.8 ローカル言語で書かれたコマンドの評価

/*&common

void ox_execute_string(ox_file_t sv, char* str);

void ox_execute_string(OXFILE *sv, char* str);

/*&ja

Line 293 void ox_execute_string(ox_file_t sv, char* str);

Line 347 void ox_execute_string(ox_file_t sv, char* str);

/*&ja

3.9 関数呼び出し

4.9 関数呼び出し

/*&common

int ox_cmo_rpc(ox_file_t sv, char *function, int argc, cmo *argv[]);

int ox_cmo_rpc(OXFILE *sv, char *function, int argc, cmo *argv[]);

/*&ja

Line 305 function(argv[1], ...) を計算し、結果をスタックに積む�

Line 359 function(argv[1], ...) を計算し、結果をスタックに積む�

/*&ja

3.10 Mathcap の受信

4.10 Mathcap の受信

/*&common

cmo_mathcap* ox_mathcap(ox_file_t sv);

cmo_mathcap* ox_mathcap(OXFILE *sv);

/*&ja

Line 318 Mathcap を受け取る。現在は Mathcap の処理はユーザプロ�

Line 372 Mathcap を受け取る。現在は Mathcap の処理はユーザプロ�

/*&ja

4. 低水準 API

5. 低水準 API

低水準 API はファイルディスクリプタを直接利用する。

4.1 通信に使われるバイトオーダの決定

5.1 通信に使われるバイトオーダの決定

/*&en

4. Low-level API.

5. Low-level API.

In this section, ``fd'' is an identifier of an OpenXM connection.

4.1 How to decide a byte order of integers?

5.1 How to decide a byte order of integers?

/*&common

Line 351 as an expression for integers.

Line 405 as an expression for integers.

/*&common

4.2

5.2

/*&common

Line 369 receive_int32() reads 32bits integer from an OpenXM co

Line 423 receive_int32() reads 32bits integer from an OpenXM co

/*&common

4.3

5.3

/*&common

Line 387 receive_cmo() reads an CMObject from an OpenXM connect

Line 441 receive_cmo() reads an CMObject from an OpenXM connect

/*&common

4.4

5.4

/*&common

Line 402 next_serial() generates a serial number for ox message

Line 456 next_serial() generates a serial number for ox message

/*&common

4.5

5.5

/*&common

Line 422 receive_ox_tag() reads a tag and a serial number of an

Line 476 receive_ox_tag() reads a tag and a serial number of an

/*&common

4.6 Sending OX messages.

5.6 Sending OX messages.

/*&common

Line 437 OX メッセージを送信する。

Line 491 OX メッセージを送信する。

/*&ja

5. OX expression パーサ

6. OX expression パーサ

/*&en

5. Parser for OX expressions

6. Parser for OX expressions

/*&ja

Line 456 encoded OX/CMO expression. In this section, we explai

Line 510 encoded OX/CMO expression. In this section, we explai

/*&en

5.1 Setting an option

6.1 Setting an option

/*&ja

5.1 オプション

6.1 オプション

/*&common

Line 477 expressios.

Line 531 expressios.

/*&en

5.2 Initializing

6.2 Initializing

/*&ja

5.2 初期化

6.2 初期化

/*&common

Line 496 We give the parser an OX/CMO expression, that is, a Li

Line 550 We give the parser an OX/CMO expression, that is, a Li

/*&en

5.3 Getting an object

6.3 Getting an object

/*&ja

5.3 結果を得る

6.3 結果を得る

/*&common

Line 517 then the parser returns NULL.

Line 571 then the parser returns NULL.

/*&ja

7. 付属プログラムについて

7. Mathcap クラス

データベース

7.1. 概要

Mathcap クラスは OpenXM アプリケーションの Mathcap を表現するクラスで

ある。これは cmo_mathcap とは別物である。Mathcap クラスのインスタンス

は各通信路ごとに生成され、OXFILE クラスのメンバになる。このことは、複

数の計算プロセスと同時に通信するクライアントを作成するためである。さて、

Mathcap クラスは、静的メンバももつ。これら静的メンバは、通信路から独立

した、 OpenXM アプリケーション自体の情報を保持するために用いられる。また。

インスタンスの生成時にもその情報は利用される。

7.2. メソッド

Mathcap クラスは mathcap.c で実装されている。ユーザは次の関数を介して、

Mathcap クラスにアクセスすることができる。

void mathcap_init(int version, char *id, char *sysname, int cmo[], sm_cmd[]);

静的メンバを初期化する。Mathcap クラスのインスタンスを生成するまえに、

したがって、クライアントおよびサーバはプログラムを開始するときに、この

関数を呼ばなければならない。cmo は、そのアプリケーションの利用する CMO

のタグのリストであって、0 で終端しなければならない。NULL のときには既

定値が用いられる。sm_cmd も同様。

cmo_mathcap *mathcap_get(mathcap *this);

Mathcap クラスのインスタンスを cmo_mathcap クラスのインスタンスに変換する。

mathcap *mathcap_update(mathcap *this, cmo_mathcap *mc);

通信相手から入手した cmo_mathcap オブジェクトを用いて、Mathcap クラスの

インスタンスを更新する。

/*&ja

8. 付属プログラムについて

/*&en

7. Sample programs.

8. Sample programs.

/*&common

Line 563 GUI 表示する OpenXM サーバのサンプル。

Line 655 GUI 表示する OpenXM サーバのサンプル。

/*&ja

8. 付録

9. 付録

8.1 ox.c における関数の命名規則

9.1 ox.c における関数の命名規則

(1) receive_cmo 関数はCMOタグとデータ本体を受信する. この関数は CMOタ

グの値が事前に分からないときに使用する. 返り値として、cmo へのポインタ

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>