3.1 API一覧

TP1/Client/Jが使用するAPIの一覧を,次の表にそれぞれに示します。

表3-1 API一覧(パッケージ,クラス)

分類名称意味・機能
パッケージJP.co.Hitachi.soft.OpenTP1TP1/Client/Jのクラスのパッケージ名
クラスTP1ClientTP1/Client/Jのクラス名
DCRpcBindTblDCRpcBindTblクラス

表3-2 API一覧(メソッド)

分類メソッド意味・機能
実行系acceptNotification(byte[] inf,int[] inf_len,int port,int timeout,byte[] hostname,byte[] nodeid)サーバ側の関数(dc_rpc_cltsend関数)で通知されるメッセージを受信する。
acceptNotificationChained(byte[] inf,int[] inf_len,int timeout,byte[] hostname,byte[] nodeid)
cancelNotification(byte[] inf,int inf_len,String hostname,int port)サーバからの一方通知受信待ち状態(acceptNotificationメソッド,あるいはacceptNotificationChainedメソッドの発行)を解除する。
closeConnection()CUPと,rapリスナーおよびrapサーバとの間に確立済みの常設コネクションを切断する。
closeNotification()一方通知連続受信機能を使用するための環境を削除する。
cltAssemSend(byte[] buff, int sendleng, String hostname, int portnum, int timeout, int flags)受信メッセージの組み立て機能を使用してメッセージを送信する。
cltAssemReceive(byte[] buff, int[] recvleng, int timeout, int flags)受信メッセージの組み立て機能を使用してメッセージを受信する。
cltReceive(byte[] buff, int[] recvleng, int timeout, int flags)MHPが送信したメッセージを受信する。
cltSend(byte[] buff, int sendleng, String hostname, int portnum, int flags)MHPへメッセージを送信する。
getTrnID(byte[] gid, byte[] bid)トランザクショングローバル識別子,トランザクションブランチ識別子を取得する。
openConnection()rapサーバとの間に常設コネクションを確立するか,または,TP1/Webに接続して擬似セションを開始する。
openConnection(String host, int port)
openConnection(String url, short flags)
openNotification(int port)一方通知連続受信機能を使用するための環境を作成する。
rpcCall(String group, String service, byte[] in_data, int[] in_len, byte[] out_data, int[] out_len, int flags)指定された「サービスグループ名+サービス名」に対してRPCを行う。
rpcCall(String group, String service, byte[] in_data, byte[] out_data, int flags)
rpcCallTo(DCRpcBindTbl direction, String group, String service, byte[] in_data, int[] in_len, byte[] out_data, int[] out_len, int flags)指定された通信先ノードの「サービスグループ名+サービス名」に対してRPCを行う。
rpcClose()TP1/ServerのSPPを呼び出すための環境を解放する。
rpcOpen()TP1/ServerのSPPを呼び出すための環境を初期化する。
rpcOpen(String deffilename)
trnBegin()グローバルトランザクションを開始する。
trnChainedCommit()トランザクションの同期点を取得する。
trnChainedRollback()トランザクションをロールバックする。
trnInfo()TP1Clientオブジェクトがトランザクションとして稼働しているか確認する。
trnUnchainedCommit()トランザクションの同期点を取得する。
trnUnchainedRollback()トランザクションをロールバックする。
定義系setConnectInformation(byte[] inf, short inf_len)端末識別情報を設定する。
setDataTraceMode(String TrcPath, int size, int Datasize, boolean flag)JavaアプリケーションおよびJavaサーブレットからRPCを行うとき,データトレースをファイルに出力するかどうかを指定する。
setDccltdelay(int sec)CUPとrapリスナーおよびrapサーバ間の通信遅延時間を設定する。
setDccltextend(int flags)TP1/Client/Jの機能の拡張レベルを設定する。各指定値の論理和を設定すると,複数の機能の拡張レベルを指定できる。
setDccltinquiretime(int sec)rapサーバが監視する問い合わせ間隔最大時間(クライアントから一定時間サービス要求が来ない場合に接続を切断する時間)を設定する。
setDchost(String host, int port)窓口となるTP1/Serverのホスト名とポート番号を設定する。
setDcselint(int msec)このメソッドは意味を持ちません。
旧バージョンからのソースの互換性を保証するためだけに残しています。
setDcwatchtim(int sec)同期応答型RPCの場合に,CUPからSPPへサービス要求を送ってからサービスの応答が返るまでの最大応答待ち時間を設定する。
setErrorTraceMode(String TrcPath, int size, boolean flag)JavaアプリケーションおよびJavaサーブレットからTP1Clientクラスを呼び出すとき,サーバとの接続,切断,およびエラートレースをファイルに出力するかどうかを指定する。
setMethodTraceMode(String TrcPath, int size, boolean flag)JavaアプリケーションおよびJavaサーブレットからTP1Clientクラスを呼び出すとき,メソッドトレースをファイルに出力するかどうかを指定する。
setRpcextend(int extendoption)RPC関連の設定を変更する。
setScdDirectObject(String scdhost, int scdport, int flags)通信先スケジューラのホスト名,ポート番号を設定する。
setTraceArray(String[] array)Javaアプリケーション,JavaサーブレットおよびJavaアプレットからTP1Clientクラスを呼び出すとき,サーバとの接続,切断,およびエラートレースを格納するための配列(メモリトレース)を指定する。障害情報を参照するには,この配列の内容をJavaアプリケーション,JavaサーブレットまたはJavaアプレットで参照する。
setUapTraceMode(String TrcPath, int size, boolean flag)JavaアプリケーションおよびJavaサーブレットからTP1Clientクラスを呼び出すとき,UAPトレースをファイルに出力するかどうかを指定する。
注※
このメソッドを使用できるのは,JavaアプリケーションまたはJavaサーブレットだけです。Javaアプレットで使用するとSecurityExceptionが発生します。