3.1. 通信

通信クラスの概要について説明します。

クラス名:VISCom

本クラスはWebOTXサーバ<->VIS間の通信(開放型OLF/TPプロトコル、OLF/TP-UWプロトコル)機能を提供します。

OLF/TPプロトコルの詳細については、「OLF/TP利用の手引き」を参照してください。

以下に、通信処理の概要を説明します。

接続(開放型OLF/TPプロトコル)

接続(connect)メソッドを呼び出した延長で、ソケットレベルの接続を行います。その後DFinitを送信し、DFinitを受信します。送信したDFinitと受信したDFinitの値を元にネゴシエーションします。

接続の概要

接続(OLF/TP-UWプロトコル)

論理接続(PLstart)メソッドを呼び出した延長で論理端末の接続を行います。
(ソケットレベルの接続は物理接続(Pstart)メソッドを呼び出した延長で行われます。)

切断(開放型OLF/TPプロトコル)

切断(disConnect)メソッドを呼び出した延長で、ソケットレベルの切断を行います。

切断の概要

切断(OLF/TP-UWプロトコル)

論理切断(PLstop)メソッドを呼び出した延長で論理端末の切断を行います。
(ソケットレベルの切断は物理切断(Pstop)メソッドを呼び出した延長で行われます。)

データ送信

送信(send)メソッドを呼び出した延長で、ユーザデータにOLF/TPプロトコルヘッダを付加して送信します。通信状態によりTXreqかTXreplyを判断しトランザクション種別に設定します。接続時のネゴシエーションの結果、規定送達の場合は、データ送信後、自動的にack/confデータの受信を行います。

データ送信の概要

データ受信

受信(recv)メソッドを呼び出した延長でデータを受信し、OLF/TPプロトコルヘッダを削除してユーザに通知します。接続時のネゴシエーションの結果、規定送達の場合は、データ受信後、自動的にack/confデータの送信を行います。

また、受信メソッドの呼び出し以外でも、一定時間毎にデータを受信し通信クラス内に受信データを保存します。保存した受信データは受信メソッドの呼び出しにより取得できます。

データ受信の概要

3.1.1. API概要

VISComクラス

VISComコンストラクタ
setHostNameホスト接続時のホスト名を設定する
getHostNameホスト名を取得する
setServiceNameホスト接続時のホストのサービス名を設定する
getServiceNameホストのサービス名を取得する
setBindServiceNameクライアントのサービス名を設定する
getBindServiceNameクライアントのサービス名を取得する
setSocketTimerソケットの受信待ちタイマ値を設定する
getSocketTimerソケットの受信待ちタイマ値を取得する
setSendPacing送信用ペーシング値を設定する
getSendPacing送信用ペーシング値を取得する
setRecvPacing受信用ペーシング値を設定する
getRecvPacing受信用ペーシング値を取得する
setEXTField拡張領域の使用を指示する
getEXTField拡張領域の使用フラグを取得する
getLastError最後に発生したエラーを取得する
connectホストとTCP/IPのソケットを使用して接続し、DFinitメッセージのネゴシエーションを行う
disConnectホストとの接続を解放する
sendユーザが指定したデータをホストに送信する
recvホストからのデータを受信する
getRecvDataCount受信バッファに残っているデータ数を返却する
startTraceトレースの取得を開始する
stopTraceトレースの取得を終了する
setAckConfCount規定送達の場合の送信時にack/confの受信のリトライ回数を指定する
resetStatus通信状態を接続状態に戻す
getInitModeDFInitのネゴシエーションの結果(規定送達/無送達)を返却する

OLFSendDataInfoクラス

OLFSendDataInfo 送信時の付加情報クラス

OLFRecvDataInfoクラス

OLFRecvDataInfo 受信時の付加情報クラス

VCAComクラス

VCAComコンストラクタ
setHostNameホスト接続時のホスト名を設定する
getHostNameホスト名を取得する
setServiceNameホスト接続時のホストのサービス名を設定する
getServiceNameホストのサービス名を取得する
setBindServiceNameクライアントのサービス名を設定する
getBindServiceNameクライアントのサービス名を取得する
setSocketTimerソケットの受信待ちタイマ値を設定する
getSocketTimerソケットの受信待ちタイマ値を取得する
setSendPacing送信用ペーシング値を設定する
getSendPacing送信用ペーシング値を取得する
setRecvPacing受信用ペーシング値を設定する
getRecvPacing受信用ペーシング値を取得する
setEXTField拡張領域の使用を指示する
getEXTField拡張領域の使用フラグを取得する
getLastError最後に発生したエラーを取得する
connectEXホストとTCP/IPのソケットを使用して接続し、DFinitメッセージのネゴシエーションを行う
disConnectEXホストとの接続を解放する
sendユーザが指定したデータをホストに送信する
recvホストからのデータを受信する
LIホストにログインする
LOホストからログアウトする
getStatusホストとの接続状態を取得する
setStatusホストとの接続状態を設定する
isConnectedホストに接続済みか確認する
checkRetIDトランザクションの実行結果を取得
getRecvDataCount受信バッファに残っているデータ数を返却する
startTraceトレースの取得を開始する
stopTraceトレースの取得を終了する
setAckConfCount規定送達の場合の送信時にack/confの受信のリトライ回数を指定する
resetStatus通信状態を接続状態に戻す
getInitModeDFInitのネゴシエーションの結果(規定送達/無送達)を返却する

VISComUWクラス

VISComUWコンストラクタ
Pstart物理パスに対する接続を行う
Pstop物理パスに対する切断を行う
PLstart論理パスに対する接続を行う
PLstop論理パスに対する切断を行う
sendユーザが指定したデータをホストに送信する
recvデータを受信する
resetStatusトレースの取得を終了する

OLFUWSendDataInfoクラス

OLFUWSendDataInfo送信時の付加情報クラス

OLFUWRecvDataInfoクラス

OLFUWRecvDataInfo受信時の付加情報クラス

OLFUWRecvDataInfoクラス

OLFUWRecvDataInfo受信時の付加情報クラス

VCAComUWクラス

VCAComUWコンストラクタ
PstartEXホストとTCP/IPのソケットを使用して接続する
PstopEXソケットレベルのコネクション切断を行う
PLstartEX論理パスに対する接続を行う
PLstopEX論理パスに対する切断を行う
LIホストにログインする
LOホストからログアウトする
sendユーザが指定したデータをホストに送信する
recvデータを受信する
resetStatus通信状態を接続状態に戻す


3.1.1.1. VISCom


名称 VISCom - コンストラクタ
形式
 void VISCom(String SGFile)
    
説明

コンストラクタ。

SGFile - コネクタ定義ファイル名を絶対パスで指定します。

指定したコネクタ定義ファイルの情報を読み込み動作します。
コネクタ定義ファイルを指定しない(パラメータの無い)コンストラクタもあります。

戻り値 ありません。
エラー VISConException:コネクタ定義ファイルのアクセスに失敗した場合
関連項目 ありません。


3.1.1.2. setHostName


名称 setHostName - ホスト接続時のホスト名を設定する
形式
 void setHostName(String hostName)
    
説明

ホスト接続時のホスト名を設定します。

hostName - ホスト名

引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.3. getHostName


名称 getHostName - ホスト名を取得する
形式
 String getHostName()
    
説明

ホスト名を取得します。

ホスト名を設定していない場合は空文字を返却します。

戻り値 ホスト名
エラー ありません。
関連項目 ありません。


3.1.1.4. setServiceName


名称 setServiceName - ホスト接続時のホストのサービス名を設定する
形式
 void setServiceName(String serviceName)
    
説明

ホスト接続時のホストのサービス名を設定します。

serviceName - ホストのサービス名(バインド名)

引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.5. getServiceName


名称 getServiceName - ホストのサービス名を取得する
形式
 String getServiceName()
    
説明

ホストのサービス名を取得します。

ホストのサービス名を設定していない場合は空文字を返却します。

戻り値 ホストのサービス名
エラー ありません。
関連項目 ありません。


3.1.1.6. setBindServiceName


名称 setBindServiceName - クライアントのサービス名を設定する
形式
 void setBindServiceName(String bindServiceName)
    
説明

クライアントのサービス名を設定します。

bindServiceName - クライアントのサービス名(バインド名)

引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.7. getBindServiceName


名称 getBindServiceName - クライアントのサービス名を取得する
形式
 String getBindServiceName()
    
説明

クライアントのサービス名を取得します。

クライアントのサービス名を設定していない場合は空文字を返却します。

戻り値 クライアントのサービス名
エラー ありません。
関連項目 ありません。


3.1.1.8. setSocketTimer


名称 setSocketTimer - ソケットの受信待ちタイマ値を設定する
形式
 void setSocketTimer(int time)
    
説明

ソケットの受信待ちタイマ値を設定します。

time - ソケットのタイマ値(10〜999000:単位はミリ秒)

設定しない時はデフォルト(5000:5秒)となります。Connectメソッド発行前に値を変更してください。Connectメソッド発行後に変更しても値は反映しません。範囲外の値を設定した場合はデフォルト値として動作します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.9. getSocketTimer


名称 getSocketTimer - ソケットの受信待ちタイマ値を取得する
形式
 int getSocketTimer()
    
説明

ソケットの受信待ちタイマ値を取得します。

戻り値 ソケットのタイマ値
エラー ありません。
関連項目 ありません。


3.1.1.10. setSendPacing


名称 setSendPacing - 送信用ペーシング値を設定する
形式
 void setSendPacing(int pacing)
    
説明

送信用ペーシング値を設定します。

pacing - ペーシング値(0もしくは1)

設定しない時はデフォルト(1)となります。0,1以外の値を設定した場合は1として動作します。
ペーシング値に0を設定した場合は、ホスト側の値に関わらず、送信ペーシングは0となります。
引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー VISConException:0,1以外の値を設定した場合
関連項目 ありません。


3.1.1.11. getSendPacing


名称 getSendPacing - 送信用ペーシング値を取得する
形式
 int getSendPacing()
    
説明

送信用ペーシング値を取得します。

connectメソッド実行後は、ホストとネゴシエーションした結果のペーシング値を設定します。

戻り値 ペーシング値
エラー ありません。
関連項目 ありません。


3.1.1.12. setRecvPacing


名称 setRecvPacing - 受信用ペーシング値を設定する
形式
 void setRecvPacing(int pacing)
    
説明

受信用ペーシング値を設定します。

pacing - ペーシング値(0もしくは1)

設定しない時はデフォルト(1)となります。0,1以外の値を設定した場合は1として動作します。
ペーシング値に0を設定した場合は、ホスト側の値に関わらず、送信ペーシングは0となります。
引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.13. getRecvPacing


名称 getRecvPacing - 受信用ペーシング値を取得する
形式
 int getRecvPacing()
    
説明

受信用ペーシング値を取得します。

Connectメソッド実行後は、ホストとネゴシエーションした結果のペーシング値を設定します。

戻り値 ペーシング値
エラー ありません。
関連項目 ありません。


3.1.1.14. setEXTField


名称 setEXTField - 拡張領域の使用を指示する
形式
 void setEXTField(boolean useFlg)
    
説明

拡張領域の使用を指示します。

useFlg -
true拡張領域を使用します。
false拡張領域を使用しません。

設定しない時はデフォルト(false)となります。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.15. getEXTField


名称 getEXTField - 拡張領域の使用フラグを取得する
形式
 boolean getEXTField()
    
説明

拡張領域の使用フラグを取得します。

戻り値
true - 拡張領域を使用します。
false - 拡張領域を使用しません。
エラー ありません。
関連項目 ありません。


3.1.1.16. getLastError


名称 getLastError - 最後に発生したエラーを取得する
形式
 String getLastError()
    
説明

最後に発生したエラーを取得します。

エラーが発生していない場合は空白文字を返却します。

戻り値 エラー文字列
エラー ありません。
関連項目 ありません。


3.1.1.17. connect


名称 connect - ホストとTCP/IPのソケットを使用して接続し、DFinitメッセージのネゴシエーションを行う
形式
 void connect()
 void connect( String hostName, String serviceName, String localSName,
               int retryCount, int IntervalTimer, int pacing)
    
説明

ホストとTCP/IPのソケットを使用して接続し、DFinitメッセージのネゴシエーションを行います。

hostName - ホスト名(IPアドレス)
serviceName - ホストのサービス名(ポート番号を10進数で指定します)
localSName - ローカルポート番号
retryCount - リトライ回数(1〜99)
IntervalTimer - リトライ間隔(0〜999秒)
pacing - 送受信ペーシング値

ホストとTCP/IPのソケットを使用して接続します。正常に接続できた場合はDFinitの送信/受信によりネゴシエーションを行います。
リトライ回数、リトライ間隔は送受信メソッド共通で使用します。
引数なしのconnectを使用する場合は、予めSetHostNameやSetServiceName等を使用して値を設定する必要があります。

戻り値 ありません。
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.1.18. disConnect


名称 disConnect - ホストとの接続を解放する
形式
 void disConnect()
    
説明

ホストとの接続を解放します。

戻り値 ありません。
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.1.19. send


名称 send - ユーザが指定したデータをホストに送信する
形式
 void send(boolean extArea, String TXID,String FormatID, 
           int PFkey, boolean mark, boolean retry,
           byte sendBuffer[], int DataLength, 
           OLFSendDataInfo sendInfo, OLFRecvDataInfo recvInfo)
    
説明

ユーザが指定したデータをホストに送信します。

extArea - 拡張領域の使用フラグ(true:使用する false:使用しない)
TXID - トランザクションID
FormatID - フォーマットID
PFKey - 入力制御情報
mark - 確認型/非確認型フラグ(true:確認型 false:非確認型)
retry - リトライフラグ(true:リトライあり false:リトライなし)
sendBuffer - 送信データ
DataLength - 送信データ長
sendInfo - 送信データの付加情報
recvInfo - 受信したack/confデータの付加情報

ユーザから指定されたデータに、

OLF/TPプロトコルヘッダ
拡張領域
を追加してサーバに送信します。
規定送達の場合は、データ送信後、TXack/TXconfの受信を待ち合わせます。受信したTXack/TXconfデータの情報はrecvInfoに設定します。

戻り値 ありません。
エラー VISConException:通信エラー発生時、markに0,1以外の値を設定
関連項目 ありません。


3.1.1.20. recv


名称 recv - データを受信する
形式
 int recv(byte recvBuffer[], int bufferSize, boolean retry
          OLFRecvDataInfo dataInfo)
    
説明

データを受信します。

recvBuffer - 受信用バッファ
bufferSize - 受信バッファサイズ
retry - リトライフラグ(true:リトライあり false:リトライなし)
dataInfo - 受信データの付加情報

受信データが存在しない場合は、例外を返却します。受信バッファサイズが実際のデータサイズよりも小さい場合は例外を発生します。
規定送達の場合は、データ受信後対応するTXack/TXconfを送信します。

戻り値 受信データサイズ
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.1.21. getRecvDataCount


名称 getRecvDataCount - 受信バッファに残っているデータ数を返却する
形式
 int getRecvDataCount()
    
説明

受信バッファに残っているデータ数を返却します。

戻り値 データ数
エラー ありません。
関連項目 ありません。


3.1.1.22. startTrace


名称 startTrace - トレースの取得を開始する
形式
 void startTrace(String traceFileName, int traceLevel)
 void startTrace(String traceFileName, int traceLevel,
                 int traceFileSize)
    
説明

トレースの取得を開始します。

traceFileName - トレースファイル名
traceLevel - トレースレベル
0 - 概要トレース
1 - 詳細トレース
traceFileSize - トレースファイルサイズ(8〜65535)

トレースファイル名は絶対パスで指定する必要があります。実際のファイル名は、traceFileNameの値+時間+“.trc”となります。
トレースファイルサイズはKバイト単位とし、範囲外の値を設定した場合は128Kバイトとして動作します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.23. stopTrace


名称 stopTrace - トレースの取得を終了する
形式
 void stopTrace()
    
説明

トレースの取得を終了します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.24. setAckConfCount


名称 setAckConfCount - 規定送達の場合の送信時にack/confの受信のリトライ回数を指定する
形式
 void setAckConfCount(int count)
    
説明

規定送達の場合の送信時にack/confの受信のリトライ回数を指定します。

count - リトライ回数(1〜1024)

リトライ回数に範囲外の値を設定した場合は、デフォルト値(5)とします。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.25. resetStatus


名称 resetStatus - 通信状態を接続状態に戻す
形式
 void resetStatus()
    
説明

通信状態を接続状態に戻します。

接続していない場合は通信状態は変更しません。受信バッファに保持しているデータは全て破棄します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.1.26. getInitMode


名称 getInitMode - DFInitのネゴシエーションの結果(規定送達/無送達)を返却する
形式
 boolean getInitMode()
    
説明

DFInitのネゴシエーションの結果(規定送達/無送達)を返却します。

connectメソッド実行前に本メソッドを実行した場合は常にfalseを返却します。

戻り値 ネゴシエーションの結果
true規定送達
false無送達
エラー ありません。
関連項目 ありません。


3.1.2.1. OLFSendDataInfo


名称 OLFSendDataInfo - 送信時の付加情報クラス
形式
 package jp.co.nec.WbOlf;
 public final class OLFSendDataInfo {
   public int sendMsgSeqnum;      // 送信メッセージのシーケンス番号
   public int sendMsgReplySeqnum; // 送信メッセージのリプライシーケンス番号
 }
    
説明

送信時の付加情報クラスです。

sendMsgSeqnum - 送信メッセージのシーケンス番号
sendMsgReplySeqnum - 送信メッセージのリプライシーケンス番号

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.3.1. OLFRecvDataInfo


名称 OLFRecvDataInfo - 受信時の付加情報クラス
形式
 package jp.co.nec.WbOlf;
 public final class OLFRecvDataInfo {
   public String recvMsgTXID;      // トランザクションID
   public String recvMsgFormatID;  // フォーマットID
   public int recvMsgSeqnum;       // 受信メッセージのシーケンス番号
   public int recvMsgReplySeqnum;  // 受信メッセージのリプライシーケンス番号
   public int PFKey;               // PFキーの値
   public boolean mark;            // 確認型・非確認型
   public int kind;                // メッセージ種別 
   public int retID;               // リターン値
   public int DFInd;               // 通信制御情報
   public int Detail;              // 詳細コード
 }
  
説明

受信時の付加情報クラスです。

recvMsgTXID - トランザクションID
recvMsgFormatID - フォーマットID
recvMsgSeqnum - 受信メッセージのシーケンス番号
recvMsgReplySeqnum - 受信メッセージのリプライシーケンス番号
PFKey - PFキーの値
mark - 確認型・非確認型
kind - メッセージ種別
0x101TXreq
0x102TXack
0x103TXreply
0x104TXconf
0x206DFctrl
retID - リターン値
DFInd - 通信制御情報
Detail - 詳細コード

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.1. VCACom


名称 VCACom - コンストラクタ
形式
 void VCACom()
    
説明

コンストラクタ。

WebOTX統合運用管理ツールにて指定したコネクタ定義ファイルの情報を読み込み動作します。

戻り値 ありません。
エラー VISConException:コネクタ定義ファイルのアクセスに失敗した場合
関連項目 ありません。


3.1.4.2. setHostName


名称 setHostName - ホスト接続時のホスト名を設定する
形式
 void setHostName(String hostName)
    
説明

ホスト接続時のホスト名を設定します。

hostName - ホスト名

引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.3. getHostName


名称 getHostName - ホスト名を取得する
形式
 String getHostName()
    
説明

ホスト名を取得します。

ホスト名を設定していない場合は空文字を返却します。

戻り値 ホスト名
エラー ありません。
関連項目 ありません。


3.1.4.4. setServiceName


名称 setServiceName - ホスト接続時のホストのサービス名を設定する
形式
 void setServiceName(String serviceName)
    
説明

ホスト接続時のホストのサービス名を設定します。

serviceName - ホストのサービス名(バインド名)

引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.5. getServiceName


名称 getServiceName - ホストのサービス名を取得する
形式
 String getServiceName()
    
説明

ホストのサービス名を取得します。

ホストのサービス名を設定していない場合は空文字を返却します。

戻り値 ホストのサービス名
エラー ありません。
関連項目 ありません。


3.1.4.6. setBindServiceName


名称 setBindServiceName - クライアントのサービス名を設定する
形式
 void setBindServiceName(String bindServiceName)
    
説明

クライアントのサービス名を設定します。

bindServiceName - クライアントのサービス名(バインド名)

引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.7. getBindServiceName


名称 getBindServiceName - クライアントのサービス名を取得する
形式
 String getBindServiceName()
    
説明

クライアントのサービス名を取得します。

クライアントのサービス名を設定していない場合は空文字を返却します。

戻り値 クライアントのサービス名
エラー ありません。
関連項目 ありません。


3.1.4.8. setSocketTimer


名称 setSocketTimer - ソケットの受信待ちタイマ値を設定する
形式
 void setSocketTimer(int time)
    
説明

ソケットの受信待ちタイマ値を設定します。

time - ソケットのタイマ値(10〜999000:単位はミリ秒)

設定しない時はデフォルト(5000:5秒)となります。Connectメソッド発行前に値を変更してください。Connectメソッド発行後に変更しても値は反映しません。範囲外の値を設定した場合はデフォルト値として動作します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.9. getSocketTimer


名称 getSocketTimer - ソケットの受信待ちタイマ値を取得する
形式
 int getSocketTimer()
    
説明

ソケットの受信待ちタイマ値を取得します。

戻り値 ソケットのタイマ値
エラー ありません。
関連項目 ありません。


3.1.4.10. setSendPacing


名称 setSendPacing - 送信用ペーシング値を設定する
形式
 void setSendPacing(int pacing)
    
説明

送信用ペーシング値を設定します。

pacing - ペーシング値(0もしくは1)

設定しない時はデフォルト(1)となります。0,1以外の値を設定した場合は1として動作します。
ペーシング値に0を設定した場合は、ホスト側の値に関わらず、送信ペーシングは0となります。
引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー VISConException:0,1以外の値を設定した場合
関連項目 ありません。


3.1.4.11. getSendPacing


名称 getSendPacing - 送信用ペーシング値を取得する
形式
 int getSendPacing()
    
説明

送信用ペーシング値を取得します。

connectメソッド実行後は、ホストとネゴシエーションした結果のペーシング値を設定します。

戻り値 ペーシング値
エラー ありません。
関連項目 ありません。


3.1.4.12. setRecvPacing


名称 setRecvPacing - 受信用ペーシング値を設定する
形式
 void setRecvPacing(int pacing)
    
説明

受信用ペーシング値を設定します。

pacing - ペーシング値(0もしくは1)

設定しない時はデフォルト(1)となります。0,1以外の値を設定した場合は1として動作します。
ペーシング値に0を設定した場合は、ホスト側の値に関わらず、送信ペーシングは0となります。
引数なしのconnectを使用する場合に、本メソッドを使用します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.13. getRecvPacing


名称 getRecvPacing - 受信用ペーシング値を取得する
形式
 int getRecvPacing()
    
説明

受信用ペーシング値を取得します。

Connectメソッド実行後は、ホストとネゴシエーションした結果のペーシング値を設定します。

戻り値 ペーシング値
エラー ありません。
関連項目 ありません。


3.1.4.14. setEXTField


名称 setEXTField - 拡張領域の使用を指示する
形式
 void setEXTField(boolean useFlg)
    
説明

拡張領域の使用を指示します。

useFlg -
true拡張領域を使用します。
false拡張領域を使用しません。

設定しない時はデフォルト(false)となります。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.15. getEXTField


名称 getEXTField - 拡張領域の使用フラグを取得する
形式
 boolean getEXTField()
    
説明

拡張領域の使用フラグを取得します。

戻り値
true - 拡張領域を使用します。
false - 拡張領域を使用しません。
エラー ありません。
関連項目 ありません。


3.1.4.16. getLastError


名称 getLastError - 最後に発生したエラーを取得する
形式
 String getLastError()
    
説明

最後に発生したエラーを取得します。

エラーが発生していない場合は空白文字を返却します。

戻り値 エラー文字列
エラー ありません。
関連項目 ありません。


3.1.4.17. connectEX


名称 connectEX - ホストとTCP/IPのソケットを使用して接続し、DFinitメッセージのネゴシエーションを行う
形式
 void connectEX()
    
説明

ホストとTCP/IPのソケットを使用して接続し、DFinitメッセージのネゴシエーションを行います。

ホストとTCP/IPのソケットを使用して接続します。正常に接続できた場合はDFinitの送信/受信によりネゴシエーションを行います。

戻り値 ありません。
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.4.18. disConnectEX


名称 disConnectEX - ホストとの接続を解放する
形式
 void disConnectEX()
    
説明

ホストとの接続を解放します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.19. send


名称 send - ユーザが指定したデータをホストに送信する
形式
 void send(boolean extArea, String TXID,String FormatID, 
           int PFkey, boolean mark, boolean retry,
           byte sendBuffer[], int DataLength, 
           OLFSendDataInfo sendInfo, OLFRecvDataInfo recvInfo)
    
説明

ユーザが指定したデータをホストに送信します。

extArea - 拡張領域の使用フラグ(true:使用する false:使用しない)
TXID - トランザクションID
FormatID - フォーマットID
PFKey - 入力制御情報
mark - 確認型/非確認型フラグ(true:確認型 false:非確認型)
retry - リトライフラグ(true:リトライあり false:リトライなし)
sendBuffer - 送信データ
DataLength - 送信データ長
sendInfo - 送信データの付加情報
recvInfo - 受信したack/confデータの付加情報

ユーザから指定されたデータに、

OLF/TPプロトコルヘッダ
拡張領域
を追加してサーバに送信します。
規定送達の場合は、データ送信後、TXack/TXconfの受信を待ち合わせます。受信したTXack/TXconfデータの情報はrecvInfoに設定します。

戻り値 ありません。
エラー VISConException:通信エラー発生時、markに0,1以外の値を設定
関連項目 ありません。


3.1.4.20. recv


名称 recv - データを受信する
形式
 int recv(byte recvBuffer[], int bufferSize, boolean retry
          OLFRecvDataInfo dataInfo)
    
説明

データを受信します。

recvBuffer - 受信用バッファ
bufferSize - 受信バッファサイズ
retry - リトライフラグ(true:リトライあり false:リトライなし)
dataInfo - 受信データの付加情報

受信データが存在しない場合は、例外を返却します。受信バッファサイズが実際のデータサイズよりも小さい場合は例外を発生します。
規定送達の場合は、データ受信後対応するTXack/TXconfを送信します。

戻り値 受信データサイズ
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.4.21. LI


名称 LI - ホストにログインする
形式
 void LI (String loginName)
    
説明

ホストに指定したログイン名で、ログインします。

loginName - ログイン名を指定します。

戻り値 ありません。
エラー

VISConException:通信エラー発生時

VISConException:ログインエラー発生時

関連項目 ありません。


3.1.4.22. LO


名称 LO - ホストからログアウトする
形式
 void LO ()
    
説明

ホストからログアウトします。

戻り値 ありません。
エラー

VISConException:通信エラー発生時

VISConException:ログインエラー発生時

関連項目 ありません。


3.1.4.23. getStatus


名称 getStatus - ホストとの接続状態を取得する
形式
 int getStatus()
    
説明

ホストとの接続状態を取得します。

戻り値

接続状態

SERVAP_STATUS_DISCON - 切断状態
SERVAP_STATUS_CONN - 接続状態
SERVAP_STATUS_ERR - エラー状態

エラー ありません。
関連項目 ありません。


3.1.4.24. setStatus


名称 setStatus - ホストとの接続状態を設定する
形式
 void setStatus(int iStatus)
    
説明

ホストとの接続状態を設定します。

SERVAP_STATUS_DISCON - 切断状態
SERVAP_STATUS_CONN - 接続状態
SERVAP_STATUS_ERR - エラー状態

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.25. isConnected


名称 isConnected - ホストに接続済みか確認する
形式
 boolean isConnected()
    
説明

ホストに接続済みか確認します。

戻り値 接続状態

true - 接続中
false - 切断中

エラー ありません。
関連項目 ありません。


3.1.4.26. checkRetID


名称 checkRetID - トランザクションの実行結果を取得
形式
 int checkRetID(int retID)
    
説明

トランザクション戻り値より実行結果を取得します。

retID - トランザクション戻り値

戻り値 トランザクション実行結果

0 - トランザクション正常終了
1 - その他のエラー
2 - 要求拒否
3 - TXreqの応答でPLstopが返却されました[UW]

エラー ありません。
関連項目 ありません。


3.1.4.27. getRecvDataCount


名称 getRecvDataCount - 受信バッファに残っているデータ数を返却する
形式
 int getRecvDataCount()
    
説明

受信バッファに残っているデータ数を返却します。

戻り値 データ数
エラー ありません。
関連項目 ありません。


3.1.4.28. startTrace


名称 startTrace - トレースの取得を開始する
形式
 void startTrace(String traceFileName, int traceLevel)
 void startTrace(String traceFileName, int traceLevel,
                 int traceFileSize)
    
説明

トレースの取得を開始します。

traceFileName - トレースファイル名
traceLevel - トレースレベル
0 - 概要トレース
1 - 詳細トレース
traceFileSize - トレースファイルサイズ(8〜65535)

トレースファイル名は絶対パスで指定する必要があります。実際のファイル名は、traceFileNameの値+時間+“.trc”となります。
トレースファイルサイズはKバイト単位とし、範囲外の値を設定した場合は128Kバイトとして動作します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.29. stopTrace


名称 stopTrace - トレースの取得を終了する
形式
 void stopTrace()
    
説明

トレースの取得を終了します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.30. setAckConfCount


名称 setAckConfCount - 規定送達の場合の送信時にack/confの受信のリトライ回数を指定する
形式
 void setAckConfCount(int count)
    
説明

規定送達の場合の送信時にack/confの受信のリトライ回数を指定します。

count - リトライ回数(1〜1024)

リトライ回数に範囲外の値を設定した場合は、デフォルト値(5)とします。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.31. resetStatus


名称 resetStatus - 通信状態を接続状態に戻す
形式
 void resetStatus()
    
説明

通信状態を接続状態に戻します。

接続していない場合は通信状態は変更しません。受信バッファに保持しているデータは全て破棄します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.4.32. getInitMode


名称 getInitMode - DFInitのネゴシエーションの結果(規定送達/無送達)を返却する
形式
 boolean getInitMode()
    
説明

DFInitのネゴシエーションの結果(規定送達/無送達)を返却します。

connectメソッド実行前に本メソッドを実行した場合は常にfalseを返却します。

戻り値 ネゴシエーションの結果
true規定送達
false無送達
エラー ありません。
関連項目 ありません。


3.1.5.1. VISComUW


名称 VISComUW - コンストラクタ
形式
 void VISComUW(String SGFile)
    
説明

コンストラクタ。

SGFile - コネクタ定義ファイル名を絶対パスで指定します。

指定したコネクタ定義ファイルの情報を読み込み動作します。

戻り値 ありません。
エラー VISConException:コネクタ定義ファイルのアクセスに失敗した場合
関連項目 ありません。


3.1.5.2. Pstart


名称 Pstart - 物理パスに対する接続を行う
形式
 void Pstart(String  hostName, String serviceName, String localName,
		int retryCount, int intervalTimer, int pacing)
    
説明

L層レベルのコネクションを開設し、PLstartの送受信を行います。

hostName - ホスト名
serviceName - ポート番号
localSName - ローカルポート番号
retryCount - リトライ回数(1〜99)
IntervalTimer - リトライ間隔(0〜999秒)
pacing - 送受信ペーシング値

ホストとTCP/IPのソケットを使用して接続します。
リトライ回数、リトライ間隔は送受信メソッド共通で使用します。

戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.5.3. Pstop


名称 Pstop - 物理パスに対する切断を行う
形式
 void Pstop()
    
説明

ソケットレベルのコネクションを切断し、受信したデータの領域も解放します。

戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.5.4. PLstart


名称 PLstart - 論理パスに対する接続を行う
形式
 void PLstart(OLFUWRecvDataInfo	recvInfo)
    
説明

論理パスに対する接続を行います。

recvInfo - 受信データの付加情報

戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.5.5. PLstop


名称 PLstop - 論理パスに対する切断を行う
形式
 void PLstop(OLFUWRecvDataInfo	recvInfo)
    
説明

論理パスに対する切断を行います。

recvInfo - 受信データの付加情報

戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.5.6. send


名称 send - ユーザが指定したデータをホストに送信する
形式
 void send(boolean extArea, String TXID, String FormatID,
           int PFkey, boolean mark, boolean retry,
           byte UserBuffer[], int DataLength,
           OLFUWSendDataInfo sendInfo, OLFUWRecvDataInfo recvInfo)
    
説明

ユーザが指定したデータをホストに送信します。

extArea - 拡張領域の使用フラグ(true:使用する false:使用しない)
TXID - トランザクションID
FormatID - フォーマットID
PFKey - 入力制御情報
mark - 確認型/非確認型フラグ(true:確認型 false:非確認型)
retry - リトライフラグ(true:リトライあり false:リトライなし)
UserBuffer[] - 送信データ
DataLength - 送信データ長
sendInfo - 送信データの付加情報
recvInfo - 受信したack/confデータの付加情報

ユーザから指定されたデータに、

OLF/TPプロトコルヘッダ
拡張領域
を追加してサーバに送信します。
規定送達の場合は、データ送信後、TXack/TXconfの受信を待ち合わせます。受信したTXack/TXconfデータの情報はrecvInfoに設定します。

戻り値 ありません。
エラー VISConException:通信エラー発生時、markに0,1以外の値を設定
関連項目 ありません。


3.1.5.7. recv


名称 recv - データを受信する
形式
 int recv(byte UserBuffer[], int BufferSize, boolean retry,
          OLFUWRecvDataInfo recvInfo)
    
説明

データを受信します。

UserBuffer[] - 受信データの格納域
BufferSize - 受信バッファサイズ
retry - リトライフラグ(true:リトライあり false:リトライなし)
recvInfo - 受信データの付加情報

受信データが存在しない場合は、例外を返却します。受信バッファサイズが実際のデータサイズよりも小さい場合は例外を発生します。
規定送達の場合は、データ受信後対応するTXack/TXconfを送信します。

戻り値 受信データサイズ
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.5.8. resetStatus


名称 resetStatus - 通信状態を接続状態に戻す
形式
 void resetStatus()
    
説明

通信状態を接続状態に戻します。
接続していない場合は通信状態は変更しません。受信バッファに保持されているデータは全て破棄します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.6.1. OLFUWSendDataInfo


名称 OLFUWSendDataInfo - 送信時の付加情報クラス
形式
 package jp.co.nec.WbOlf;
 
 public class OLFUWSendDataInfo extends OLFSendDataInfo{
   private final static int SOURCEIDSIZE = 16;
   public byte              sourceID[] = new byte[SOURCEIDSIZE];
 }
    
説明

送信時の付加情報クラスです。

sourceID[] - 端末識別子

OLFSendDataInfoクラスを継承しています。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.7.1. OLFUWRecvDataInfo


名称 OLFUWRecvDataInfo - 受信時の付加情報クラス
形式
 package jp.co.nec.WbOlf;
 public class OLFUWRecvDataInfo extends OLFRecvDataInfo{
   private final static int SOURCEIDSIZE = 16;
   public byte              sourceID[] = new byte[SOURCEIDSIZE];
 }
  
説明

受信時の付加情報クラスです。

sourceID[] - 端末識別子

OLFRecvDataInfoクラスを継承しています。

戻り値 ありません。
エラー ありません。
関連項目 ありません。


3.1.8.1. VCAComUW


名称 VCAComUW - コンストラクタ
形式
void VCAComUW()
    
説明 コンストラクタ。
WebOTX統合運用管理ツールにて指定したコネクタ定義ファイルの情報を読み込み動作します。
戻り値 ありません。
エラー VISConException:コネクタ定義ファイルのアクセスに失敗した場合
関連項目 ありません。


3.1.8.2. PstartEX


名称 PstartEX - ホストとTCP/IPのソケットを使用して接続する
形式
void PstartEX ()
    
説明 ホストとTCP/IPのソケットを使用して接続します。
戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.8.3. PstopEX


名称 PstopEX - ソケットレベルのコネクション切断を行う
形式
void PstopEX ()
    
説明 ソケットレベルのコネクションを切断し、受信したデータの領域も解放します。
戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.8.4. PLstartEX


名称 PLstartEX - 論理パスに対する接続を行う
形式
void PLstartEX (OLFUWRecvDataInfo	recvInfo)
説明 論理パスに対する接続を行います。
recvInfo - 受信データの付加情報
戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.8.5. PLstopEX


名称 PLstopEX - 論理パスに対する切断を行う
形式
void PlstopEX (OLFUWRecvDataInfo	recvInfo)
説明 論理パスに対する切断を行います。
recvInfo - 受信データの付加情報
戻り値 ありません。
エラー VISConException:
関連項目 ありません。


3.1.8.6. LI


名称 LI - ホストにログインする
形式
void LI (byte[] sid,int seqnum,String loginName)
説明 ホストに指定したログイン名で、ログインします。
sid - 端末識別子を指定します。
seqnum - メッセージ通番を指定します。
loginName - ログイン名を指定します。
戻り値 ありません。
エラー

VISConException:通信エラー発生時
VISConException:ログインエラー発生時

関連項目 ありません。


3.1.8.7. LO


名称 LO - ホストからログアウトする
形式
void LO (byte[] sid,int seqnum)
説明 ホストからログアウトします。
sid - 端末識別子を指定します。
seqnum - メッセージ通番を指定します。
戻り値 ありません。
エラー

VISConException:通信エラー発生時
VISConException:ログインエラー発生時

関連項目 ありません。


3.1.8.8. send


名称 send - ユーザが指定したデータをホストに送信する
形式
void send(boolean extArea, String TXID, String FormatID,
           int PFkey, boolean mark, boolean retry,
           byte UserBuffer[], int DataLength,
           OLFUWSendDataInfo sendInfo, OLFUWRecvDataInfo recvInfo)
           
説明

ユーザが指定したデータをホストに送信します。


extArea - 拡張領域の使用フラグ(true:使用する false:使用しない)
TXID - トランザクションID
FormatID - フォーマットID
PFKey - 入力制御情報
mark - 確認型/非確認型フラグ(true:確認型 false:非確認型)
retry - リトライフラグ(true:リトライあり false:リトライなし)
UserBuffer[] - 送信データ
DataLength - 送信データ長
sendInfo - 送信データの付加情報
recvInfo - 受信したack/confデータの付加情報


ユーザから指定されたデータに、

    OLF/TPプロトコルヘッダ
    拡張領域
を追加してサーバに送信します。
規定送達の場合は、データ送信後、TXack/TXconfの受信を待ち合わせます。受信したTXack/TXconfデータの情報はrecvInfoに設定します。

戻り値 ありません。
エラー VISConException:通信エラー発生時、markに0,1以外の値を設定
関連項目 ありません。


3.1.8.9. recv


名称 recv - データを受信する
形式
int recv(byte UserBuffer[], int BufferSize, boolean retry,
          OLFUWRecvDataInfo recvInfo)
          
説明

データを受信します。

UserBuffer[] - 受信データの格納域
ufferSize - 受信バッファサイズ
retry - リトライフラグ(true:リトライあり false:リトライなし)
recvInfo - 受信データの付加情報

受信データが存在しない場合は、例外を返却します。受信バッファサイズが実際のデータサイズよりも小さい場合は例外を発生します。
規定送達の場合は、データ受信後対応するTXack/TXconfを送信します。

戻り値 受信データサイズ
エラー VISConException:通信エラー発生時
関連項目 ありません。


3.1.8.10. resetStatus


名称 resetStatus - 通信状態を接続状態に戻す
形式
void resetStatus ()
    
説明

通信状態を接続状態に戻します。
接続していない場合は通信状態は変更しません。受信バッファに保持されているデータは全て破棄します。

戻り値 ありません。
エラー ありません。
関連項目 ありません。