2.1. 通信
通信ライブラリの概要について説明します。
通信ライブラリは、開放型OLF/TPプロトコル、OLF/TP-UWプロトコルに準拠した通信機能を提供します。
(OLF/TPプロトコルの詳細についての説明書としては、「OLF/TP-UT利用の手引き」(ACOS-4)があります。)
通信ライブラリは、「通信クラス(OLFConn/OLFConnUW)」 「受信クラス(AsyncRecv)」 「送信/受信パラメータクラス(OLFDataInfo/OLFUWDataInfo)」 の3つのクラスで構成されています。
- 「通信クラス」は、実際に通信(送信、受信、送受信)を行うクラス。
- 「受信クラス」は、非同期受信スレッドが動作するクラス。
- 「送信/受信パラメータクラス」は、送受信時の動作のパラメータを指定するクラス。
通信ライブラリを使用して通信を行うためには、「通信クラス」と「送信/受信パラメータクラス」のオブジェクトが必須です。
以下に、通信処理の概要を説明します。
接続(開放型OLF/TPプロトコル)
接続(OLF_Connect)メソッドを呼び出した延長で、ソケットレベルの接続を行います。その後DFinitを送信し、DFinitを受信します。送信したDFinitと受信したDFinitの値を元にネゴシエーションします。

接続(OLF/TP-UWプロトコル)
論理接続(PLstart)メソッドを呼び出した延長で論理端末の接続を行います。
(ソケットレベルの接続は物理接続(Pstart)メソッドを呼び出した延長で行われます。)
切断(開放型OLF/TPプロトコル)
切断(OLF_DisConnect)メソッドを呼び出した延長で、ソケットレベルの切断を行います。

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

データ受信
受信(OLF_Recv)メソッドを呼び出した延長でデータを受信し、OLF/TPプロトコルヘッダを削除してユーザに通知します。接続時のネゴシエーションの結果、規定送達の場合は、データ受信後、自動的にack/confデータの送信を行います。
また、受信メソッドの呼び出し以外でも、一定時間毎にデータを受信し通信クラス内に受信データを保存します。保存した受信データは受信メソッドの呼び出しにより取得できます。

2.1.1. API概要
通信クラス
COLFDataInfoクラス
COLFUWDataInfoクラス
2.1.1.1. OLF_Init
| 名称 |
OLF_Init - 通信ライブラリの初期化を行う |
| 形式 |
int OLF_Init()
int OLF_Init(char* pSGFile)
|
| 説明 |
通信ライブラリの初期化を行います。
コネクタ定義ファイルが指定された場合は、指定されたコネクタ定義ファイルの情報を読み込み、動作します。
| pSGFile | - | コネクタ定義ファイル名を絶対パスで指定します。 |
OLF_Connect()の前に必ず1回だけ実行してください。 |
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: コネクタ定義ファイルのアクセスに失敗した場合 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
OLF_Connect |
2.1.1.2. OLF_SetHostName
| 名称 |
OLF_SetHostName - ホスト接続時のホスト名を設定する |
| 形式 |
void OLF_SetHostName(char* pHostName)
|
| 説明 |
ホスト接続時のホスト名を設定します。
| pHostName | - | ホスト名へのポインタを指定します。 |
引数なしのOLF_Connectを使用する場合に、本メソッドを使用します。 |
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.3. OLF_GetHostName
| 名称 |
OLF_GetHostName - ホスト名を取得する |
| 形式 |
void OLF_GetHostName(int iDataLength,char* pHostName)
|
| 説明 |
ホスト名を取得します。
| iDataLength | - | バッファ長を指定します。 |
| pHostName | - | ホスト名を格納するバッファアドレスを指定します。 |
ホスト名が設定されていない場合、指定したバッファ長よりホスト名が長い場合は、空文字を返却します。 |
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.4. OLF_SetServiceName
| 名称 |
OLF_SetServiceName - ホスト接続時のホストのサービス名を設定する |
| 形式 |
void OLF_SetServiceName(char* pServiceName)
|
| 説明 |
ホスト接続時のホストのサービス名を設定します。
| pServiceName | - | style="border: 0px"ホストのサービス名(バインド名)を指定します。 |
引数なしのOLF_Connectを使用する場合に、本メソッドを使用します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.5. OLF_GetServiceName
| 名称 |
OLF_GetServiceName - ホストのサービス名を取得する |
| 形式 |
void OLF_GetServiceName(int iDataLength,char* pServiceName)
|
| 説明 |
ホストのサービス名を取得します。
| iDataLength | - | バッファ長を指定します。 |
| pHostName | - | ホストのサービス名を格納するバッファアドレスを指定します。 |
ホストのサービス名が設定されていない場合、指定したバッファ長よりサービス名が長い場合は、空文字を返却します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.6. OLF_SetBindServiceName
| 名称 |
OLF_SetBindServiceName - クライアントのサービス名を設定する |
| 形式 |
void OLF_SetBindServiceName(char* pBindServiceName)
|
| 説明 |
クライアントのサービス名を設定します。
| pBindServiceName | - | クライアントのサービス名(バインド名)を指定します。 |
引数なしのOLF_Connectを使用する場合に、本メソッドを使用します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.7. OLF_GetBindServiceName
| 名称 |
OLF_GetBindServiceName - クライアントのサービス名を取得する |
| 形式 |
void OLF_GetBindServiceName(int iDataLength,char* pServiceName)
|
| 説明 |
クライアントのサービス名を取得します。
| iDataLength | - | バッファ長を指定します。 |
| pHostName | - | クライアントのサービス名を格納するバッファアドレスを指定します。 |
クライアントのサービス名が設定されていない場合、指定したバッファ長よりサービス名が長い場合は、空文字を返却します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.8. OLF_SetiRetry
| 名称 |
OLF_SetiRetry - ソケットのリトライフラグを設定する |
| 形式 |
void OLF_SetiRetry(int iRetry)
|
| 説明 |
ソケットのリトライフラグを設定します。(コネクト時のDFInit用)
| iRetry | - | ソケットのリトライフラグを指定します。
| OLF_RETRY | 0 | リトライ |
| OLF_NORETRY | 1 | リトライなし |
| OLF_NOWAIT | 2 | 待ち合わせなし(受信用) |
|
設定しない時はデフォルトOLF_RETRYとなります。OLF_Connectメソッド発行前に値を変更してください。
OLF_Connectメソッド発行後に変更しても値は反映されません。
範囲外の値を設定した場合はデフォルト値として動作します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.9. OLF_GetiRetry
| 名称 |
OLF_GetiRetry - ソケットのリトライフラグを取得する |
| 形式 |
int OLF_GetiRetry()
|
| 説明 |
ソケットのリトライフラグを取得します。(コネクト時のDFInit用)
|
| 戻り値 |
ソケットのリトライフラグ
| 0 | - | リトライ |
| 1 | - | リトライなし |
| 2 | - | 待ち合わせなし |
|
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.10. OLF_SetIntervalTimer
| 名称 |
OLF_SetIntervalTimer - ソケットのリトライ間隔を設定する |
| 形式 |
void OLF_SetIntervalTimer(int iTime)
|
| 説明 |
ソケットのリトライ間隔を設定します。
| iTime | - | ソケットのリトライ間隔(0〜999000:単位はミリ秒)を指定します。 |
設定しない時はデフォルト(80:80ミリ秒)となります。0が指定された場合はRetryを行いません。
OLF_Connectメソッド発行前に値を変更してください。OLF_Connectメソッド発行後に変更しても値は反映されません。範囲外の値を設定した場合はデフォルト値として動作します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.11. OLF_GetIntervalTimer
| 名称 |
OLF_GetIntervalTimer - ソケットのリトライ間隔を取得する |
| 形式 |
int OLF_GetIntervalTimer()
|
| 説明 |
ソケットのリトライ間隔を取得します。
|
| 戻り値 |
ソケットのリトライ間隔 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.12. OLF_SetRetryCount
| 名称 |
OLF_SetRetryCount - ソケットのリトライ回数を設定する |
| 形式 |
void OLF_SetRetryCount(int iCount)
|
| 説明 |
ソケットのリトライ回数を設定します。
| iCount | - | ソケットのリトライ回数(0〜999:単位は回)を指定します。 |
設定しない時はデフォルト(250回)となります。OLF_Connectメソッド発行前に値を変更してください。
OLF_Connectメソッド発行後に変更しても値は反映されません。
範囲外の値を設定した場合はデフォルト値として動作します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.13. OLF_GetRetryCount
| 名称 |
OLF_GetRetryCount - ソケットのリトライ回数を取得する |
| 形式 |
int OLF_GetRetryCount()
|
| 説明 |
ソケットのリトライ回数を取得します。
|
| 戻り値 |
ソケットのリトライ回数 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.14. OLF_SetSendPacing
| 名称 |
OLF_SetSendPacing - 送信用ペーシング値を設定する |
| 形式 |
int OLF_SetSendPacing(int iPacing)
|
| 説明 |
送信用ペーシング値を設定します。
| iPacing | - | ペーシング値(0もしくは1)を指定します。 |
設定しない時はデフォルト(1)となります。0,1以外の値を設定した場合は1として動作します。
ペーシング値に0を設定した場合は、ホスト側の値に関わらず、送信ペーシングは0となります。
引数なしのOLF_Connectを使用する場合に、本メソッドを使用します。 |
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 0,1以外の値が設定された場合 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
OLF_Connect |
2.1.1.15. OLF_GetSendPacing
| 名称 |
OLF_GetSendPacing - 送信用ペーシング値を取得する |
| 形式 |
int OLF_GetSendPacing()
|
| 説明 |
送信用ペーシング値を取得します。
OLF_Connectメソッド実行後は、ホストとネゴシエーションした結果のペーシング値が設定されます。
|
| 戻り値 |
ペーシング値 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.16. OLF_SetRecvPacing
| 名称 |
OLF_SetRecvPacing - 受信用ペーシング値を設定する |
| 形式 |
int OLF_SetRecvPacing(int iPacing)
|
| 説明 |
受信用ペーシング値を設定します。
| iPacing | - | ペーシング値(0もしくは1)を指定します。 |
設定しない時はデフォルト(1)となります。0,1以外の値を設定した場合は1として動作します。
ペーシング値に0を設定した場合は、ヒスト側の値に関わらず、送信ペーシングは0となります。
引数なしのOLF_Connectを使用する場合に、本メソッドを使用します。 |
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 0,1以外の値が設定された場合 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
OLF_Connect |
2.1.1.17. OLF_GetRecvPacing
| 名称 |
OLF_GetRecvPacing - 受信用ペーシング値を取得する |
| 形式 |
int OLF_GetRecvPacing()
|
| 説明 |
受信用ペーシング値を取得します。
OLF_Connectメソッド実行後は、ホストとネゴシエーションした結果のペーシング値が設定されます。
|
| 戻り値 |
ペーシング値 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.18. OLF_GetLastError
| 名称 |
OLF_GetLastError - 最後に発生したエラーを取得する |
| 形式 |
unsigned int OLF_GetLastError()
|
| 説明 |
最後に発生したエラーを取得します。
各メソッドの先頭でエラーをクリアするため、エラーが発生していない場合は0を返却します。
|
| 戻り値 |
エラーコード |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.19. OLF_Connect
| 名称 |
OLF_Connect - サーバと接続し、DFinitメッセージのネゴシエーションを行う |
| 形式 |
int OLF_Connect()
int OLF_Connect(char* pHostName, char* pServiceName,
char* pBindSName,int iRetry,int iRetryCount,
int iIntervalTimer,int iPacing)
|
| 説明 |
サーバと接続し、DFinitメッセージのネゴシエーションを行います。
| pHostName | - | ホスト名 |
| pServiceName | - | ホストのサービス名 |
| pBindSName | - | クライアントのサービス名 |
| iRetry | - | リトライフラグを指定します。
| OLF_RETRY | 0 | //リトライ |
| OLF_NORETRY | 1 | //リトライなし |
| OLF_NOWAIT | 2 | //待ち合わせなし |
|
| RetryCount | - | リトライ回数(0〜999) |
| iIntervalTimer | - | リトライ間隔(0〜999000ミリ秒) |
| iPacing | - | 送信ペーシング値 |
ホストとTCP/IPのソケットを使用して接続します。正常に接続できた場合はDFinitの送信/受信によりネゴシエーションを行います。
リトライ回数、リトライ間隔は送受信メソッド共通で使用します。
引数なしのOLF_Connectを使用する場合は、予めSetHostNameやSetServiceName等を使用して値を設定する必要があります。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
ありません。 |
2.1.1.20. OLF_Disconnect
| 名称 |
OLF_Disconnect - ホストとの接続を解放する |
| 形式 |
int OLF_Disconnect()
|
| 説明 |
ホストとの接続を解放します。
ホストとの接続を解除します。受信バッファに保持されているデータはすべて破棄します。 |
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
OLF_Connect |
2.1.1.21. OLF_Send
| 名称 |
OLF_Send - ユーザから指定されたデータをホストに送信する |
| 形式 |
void OLF_Send(COLFDataInfo* pCDataInfo,char* pSendBuffer,
long lDataLength,int iRetry)
|
| 説明 |
ユーザから指定されたデータをホストに送信します。
| pCDataInfo | - | データの付加情報 |
| pSendBuffer | - | 送信データ |
| lDataLength | - | 送信データ長 |
| iRetry | - | リトライフラグを指定します。
| OLF_RETRY | 0 | //リトライ |
| OLF_NORETRY | 1 | //リトライなし |
| OLF_NOWAIT | 2 | //待ち合わせなし |
|
ユーザから指定されたデータに、OLF/TPプロトコルヘッダ拡張領域を追加してサーバに送信します。
規定送達の場合は、データ送信後、TXack/TXconfの受信を待ち合わせます。受信したTXack/TXconfデータの情報はCOLFRecvDataInfoに設定されます。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時、markに0,1以外の値を設定 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
ありません。 |
2.1.1.22. OLF_Recv
| 名称 |
OLF_Recv - データを受信する |
| 形式 |
int OLF_Recv(COLFDataInfo* pCDataInfo,char* pRecvBuffer,
long lBufferSize,long* plDataLength,int iRetry)
|
| 説明 |
データを受信します。
| pCDataInfo | - | データの付加情報 |
| pRecvBuffer | - | 受信用バッファ |
| lBufferSize | - | 受信バッファサイズ |
| plDataLength | - | 受信データサイズ |
| iRetry | - | リトライフラグを指定します。
| OLF_RETRY | 0 | //リトライ |
| OLF_NORETRY | 1 | //リトライなし |
| OLF_NOWAIT | 2 | //待ち合わせなし |
|
受信データが存在しない場合は、エラーを返却します。
受信バッファサイズが実際のデータサイズよりも小さい場合もエラーを返却します。
規定送達の場合は、データ受信後対応するTXack/TXconfを送信します。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
ありません。 |
2.1.1.23. OLF_GetRecvDataCount
| 名称 |
OLF_GetRecvDataCount - 受信バッファに残っているデータ数を返却する |
| 形式 |
int OLF_GetRecvDataCount()
|
| 説明 |
受信バッファに残っているデータ数を返却します。
|
| 戻り値 |
データ数 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.24. OLF_StartTrace
| 名称 |
OLF_StartTrace - トレースの取得を開始する |
| 形式 |
void OLF_StartTrace(char* pTraceFileName, int iTraceLevel)
void OLF_StartTrace(char* pTraceFileName, int iTraceLevel,
unsigned int uiTraceFileSize)
|
| 説明 |
トレースの取得を開始します。
| pTraceFileName | - | トレースファイル名 |
| iTraceLevel | - | トレースレベルを指定します。
|
| ulTraceFileSize | - | トレースファイルサイズ(8〜65535) |
トレースファイル名は絶対パスで指定する必要があります。
ファイル名のみが指定された場合はWebOTXのログディレクトリ配下に作成されます。
実際のファイル名は、TraceFileName+時間+“.trc”となります。
トレースファイルサイズはK単位とし、範囲外の値が設定された場合は32として動作します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.25. OLF_StopTrace
| 名称 |
OLF_StopTrace - トレースの取得を終了する |
| 形式 |
void OLF_StopTrace()
|
| 説明 |
トレースの取得を終了します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.26. OLF_SetAckConfCount
| 名称 |
OLF_SetAckConfCount - 規定送達の送信時にack/confの受信のリトライ回数を指定する |
| 形式 |
void OLF_SetAckConfCount(int iCount)
|
| 説明 |
規定送達の送信時にack/confの受信のリトライ回数を指定します。
リトライ回数に範囲外の値が設定された場合は、デフォルト値(5)とします。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.27. OLF_GetAckConfCount
| 名称 |
OLF_GetAckConfCount - 規定送達の送信時にack/confの受信のリトライ回数を取得する |
| 形式 |
int OLF_GetAckConfCount()
|
| 説明 |
規定送達の送信時にack/confの受信のリトライ回数を取得します。
|
| 戻り値 |
|
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.28. OLF_ResetStatus
| 名称 |
OLF_ResetStatus - 通信状態を接続状態に戻す |
| 形式 |
void OLF_ResetStatus()
|
| 説明 |
通信状態を接続状態に戻します。
接続していない場合は通信状態は変更しません。
受信バッファに保持されているデータは全て破棄します。 |
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.29. OLF_GetInitMode
| 名称 |
OLF_GetInitMode - DFInitのネゴシエーションの結果(規定送達/無送達)を返却する |
| 形式 |
bool OLF_GetInitMode()
|
| 説明 |
DFInitのネゴシエーションの結果(規定送達/無送達)を返却します。
OLF_Connectメソッド実行前に本メソッドを実行した場合は常にfalseを返却します。
|
| 戻り値 |
ネゴシエーションの結果
|
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.30. OLF_SendACK
| 名称 |
OLF_SendACK - AutoSendACKフラグをfalseに設定した場合にackを手動で送信する |
| 形式 |
int OLF_SendACK()
|
| 説明 |
AutoSendACKフラグをfalseに設定した場合にackを手動で送信します。
OLF_Connectを実施する前にAutoSendACKフラグをfalseに設定した後、
本メソッドを使用してください。
|
| 戻り値 |
|
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.31. OLF_SetbAutoSendAck
| 名称 |
OLF_SetbAutoSendAck - AutoSendACKフラグを設定する |
| 形式 |
void OLF_SetbAutoSendAck()
|
| 説明 |
AutoSendACKフラグを設定します。
| bAutoSendAck | - | true ack自動送信
false ack手動送信 |
OLF_Connectを実施する前に設定してください。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.32. OLF_GetbAutoSendAck
| 名称 |
OLF_GetbAutoSendAck - AutoSendACKフラグを取得する |
| 形式 |
bool OLF_GetbAutoSendAck()
|
| 説明 |
AutoSendACKフラグを取得します。
OLF_Recvを実施する前に設定してください。
|
| 戻り値 |
bAutoSendAck
| true | - | ack自動送信 |
| false | - | ack手動送信 |
|
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.33. OLF_SetiAsyncIntTimer
| 名称 |
OLF_SetiAsyncIntTimer - 非同期受信スレッドのsleep時間を定義する |
| 形式 |
void OLF_SetiAsyncIntTimer()
|
| 説明 |
非同期受信スレッドのsleep時間を定義します。
| iAsyncIntTimer | - | 非同期受信スレッドのsleep時間(ミリ秒) |
OLF_Connectメソッド実行前に本メソッドを実行してください。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.34. OLF_SetFuncCallBack
| 名称 |
OLF_SetFuncCallBack - 非同期データ受信時のコールバック関数を定義する |
| 形式 |
void OLF_SetFuncCallBack()
|
| 説明 |
非同期データ受信時のコールバック関数を定義します。
| funcCallBack | - | コールバック関数のアドレス |
OLF_Connectメソッド実行前に本メソッドを実行してください。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
OLF_Connect |
2.1.1.35. Pstart
| 名称 |
Pstart - 物理パスに対する接続を行う |
| 形式 |
int Pstart(char* hostName, char* ServiceName, char* localName,
int iRetry, int retryCount, int intervalTimer, int pacing)
|
| 説明 |
ソケットレベルのコネクションを開設します。
| hostName | - | ホスト名 |
| ServiceName | - | ホストのサービス名 |
| localName | - | クライアントのサービス名 |
| iRetry | - | リトライフラグを指定します。
| OLF_RETRY | 0 | //リトライ |
| OLF_NORETRY | 1 | //リトライなし |
| OLF_NOWAIT | 2 | //待ち合わせなし |
|
| retryCount | - | リトライ回数(0〜999) |
| intervalTimer | - | リトライ間隔(0〜999000ミリ秒) |
| pacing | - | 送信ペーシング値 |
ホストとTCP/IPのソケットを使用して接続します。
リトライ回数、リトライ間隔は送受信メソッド共通で使用します。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
Pstop |
2.1.1.36. Pstop
| 名称 |
Pstop - 物理パスに対する切断を行う |
| 形式 |
int Pstop()
|
| 説明 |
ソケットレベルのコネクションを切断し、受信したデータの領域も解放します。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
Pstart |
2.1.1.37. PLstart
| 名称 |
PLstart - 論理パスに対する接続を行う |
| 形式 |
int PLstart(COLFUWDataInfo* pCOLFUWDataInfo)
|
| 説明 |
論理パスに対する接続を行います。
| pCOLFUWDataInfo | - | 受信データの付加情報 |
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
PLstop |
2.1.1.38. PLstop
| 名称 |
PLstop - 論理パスに対する切断を行う |
| 形式 |
int PLstop(COLFUWDataInfo* pCOLFUWDataInfo)
|
| 説明 |
論理パスに対する切断を行います。
| pCOLFUWDataInfo | - | 受信データの付加情報 |
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
PLstart |
2.1.1.39. OLF_Send(OLF/TP-UW用)
| 名称 |
OLF_Send(OLF/TP-UW用) - ユーザから指定されたデータをホストに送信する |
| 形式 |
int OLF_Send(COLFUWDataInfo* pCOLFUWDataInfo,
char* pSendBuffer,long lDataLength,
int iRetry)
|
| 説明 |
ユーザから指定されたデータをホストに送信します。
| pCOLFUWDataInfo | - | データの付加情報 |
| pSendBuffer | - | 送信データ |
| lDataLength | - | 送信データ長 |
| iRetry | - | リトライフラグを指定します。
| OLF_RETRY | 0 | //リトライ |
| OLF_NORETRY | 1 | //リトライなし |
| OLF_NOWAIT | 2 | //待ち合わせなし |
|
ユーザから指定されたデータに、OLF/TP-UWプロトコルヘッダ拡張領域を追加してサーバに送信します。
規定送達の場合は、データ送信後、TXack/TXconfの受信を待ち合わせます。受信したTXack/TXconfデータの情報はCOLFUWDataInfoに設定されます。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時、markに0,1以外の値を設定 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
ありません。 |
2.1.1.40. OLF_Recv(OLF/TP-UW用)
| 名称 |
OLF_Recv(OLF/TP-UW用) - データを受信する |
| 形式 |
int OLF_Recv(COLFUWDataInfo* pCOLFUWDataInfo,
char* pRecvBuffer,long lBufferSize,
long* plDataLength,int iRetry)
|
| 説明 |
データを受信します。
| pCOLFUWDataInfo | - | データの付加情報 |
| pRecvBuffer | - | 受信用バッファ |
| lBufferSize | - | 受信バッファサイズ |
| plDataLength | - | 受信データサイズ |
| iRetry | - | リトライフラグを指定します。
| OLF_RETRY | 0 | //リトライ |
| OLF_NORETRY | 1 | //リトライなし |
| OLF_NOWAIT | 2 | //待ち合わせなし |
|
受信データが存在しない場合は、エラーを返却します。
受信バッファサイズが実際のデータサイズよりも小さい場合もエラーを返却します。
規定送達の場合は、データ受信後対応するTXack/TXconfを送信します。
|
| 戻り値 |
| 0 | - | 正常 |
| -1 | - | 異常終了: 通信エラー発生時 |
|
| エラー |
OLF_GetLastErrorで取得できます。 |
| 関連項目 |
ありません。 |
2.1.1.41. SetiMark
| 名称 |
SetiMark - 確認型/非確認型を設定する |
| 形式 |
void SetiMark(int iMark)
|
| 説明 |
確認型/非確認型を設定します(送信用)。
| iMark | - | 確認型/非確認型
| OLF_REPLY | 0 | 確認型 |
| OLF_NOREPLY | 1 | 非確認型 |
|
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.42. GetiMark
| 名称 |
GetiMark - 確認型/非確認型を取得する |
| 形式 |
int GetiMark()
|
| 説明 |
確認型/非確認型を取得します。
|
| 戻り値 |
| OLF_REPLY | 0 | 確認型 |
| OLF_NOREPLY | 1 | 非確認型 |
|
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.43. SetiExtension
| 名称 |
SetiExtension - 拡張領域使用/未使用を設定する |
| 形式 |
void SetiExtension(int iExtension)
|
| 説明 |
拡張領域使用/未使用を設定します(送信用)。
| iExtension | - | 拡張領域使用/未使用
| OLF_NORM | 0 | 拡張領域未使用 |
| OLF_EXT | 1 | 拡張領域使用 |
|
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.44. GetiExtension
| 名称 |
GetiExtension - 拡張領域使用/未使用を取得する |
| 形式 |
int GetiExtension()
|
| 説明 |
拡張領域使用/未使用を取得します。
|
| 戻り値 |
| OLF_NORM | - 0 | 拡張領域未使用 |
| OLF_EXT | - 1 | 拡張領域使用 |
|
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.45. SetchTXID
| 名称 |
SetchTXID - トランザクションIDを設定する |
| 形式 |
void SetchTXID(const char* chTXID)
|
| 説明 |
トランザクションIDを設定します(送信用)。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.46. GetchTXID
| 名称 |
GetchTXID - トランザクションIDを取得する |
| 形式 |
void GetchTXID(char* pchTXID,unsigned int iLength)
|
| 説明 |
トランザクションIDを取得します。
| pchTXID | - | トランザクションID用バッファ |
| iLength | - | バッファ長 |
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.47. SetchFormatID
| 名称 |
SetchFormatID - フォーマットIDを設定する |
| 形式 |
void SetchFormatID(const char* pchFormatID)
|
| 説明 |
フォーマットIDを設定します(送信用)。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.48. GetchFormatID
| 名称 |
GetchFormatID - フォーマットIDを取得する |
| 形式 |
void GetchFormatID(char* pchFormatID,unsigned int iLength)
|
| 説明 |
フォーマットIDを取得します。
| pchFormatID | - | フォーマットID用バッファ |
| iLength | - | バッファ長 |
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.49. SetuchPFKey
| 名称 |
SetuchPFKey - PFキー(ictl)を設定する |
| 形式 |
void SetuchPFKey(unsigned char uchPFKey)
|
| 説明 |
PFキー(ictl)を設定します(送信用)。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.50. GetuchPFKey
| 名称 |
GetuchPFKey - PFキー(ictl)を取得する |
| 形式 |
unsigned char GetuchPFKey()
|
| 説明 |
PFキー(ictl)を取得します。
|
| 戻り値 |
PFキー(ictl) |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.51. SetlSeqNum
| 名称 |
SetlSeqNum - シーケンス番号を設定する |
| 形式 |
void SetlSeqNum(long lSeqNum)
|
| 説明 |
シーケンス番号を設定します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.52. GetlSeqNum
| 名称 |
GetlSeqNum - シーケンス番号を取得する |
| 形式 |
long GetlSeqNum()
|
| 説明 |
シーケンス番号を取得します。
|
| 戻り値 |
シーケンス番号 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.53. SetlReplySeqNum
| 名称 |
SetlReplySeqNum - リプライシーケンス番号を設定する |
| 形式 |
void SetlReplySeqNum(long lReplySeqNum)
|
| 説明 |
リプライシーケンス番号を設定します。
| lReplySeqNum | - | リプライシーケンス番号 |
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.54. GetlReplySeqNum
| 名称 |
GetlReplySeqNum - リプライシーケンス番号を取得する |
| 形式 |
long GetlReplySeqNum()
|
| 説明 |
リプライシーケンス番号を取得します。
|
| 戻り値 |
リプライシーケンス番号 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.55. SetusKind
| 名称 |
SetusKind - メッセージタイプを設定する |
| 形式 |
void SetusKind(unsigned short usKind)
|
| 説明 |
メッセージタイプを設定します。
| usKind | - | メッセージタイプ
| OLF_TX_REQ | 0x0101 |
| OLF_TX_ACK | 0x0102 |
| OLF_TX_REPLY | 0x0103 |
| OLF_TX_CONF | 0x0104 |
| OLF_TX_CTRL | 0x0206 |
|
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.56. GetusKind
| 名称 |
GetusKind - メッセージタイプを取得する |
| 形式 |
unsigned short GetusKind()
|
| 説明 |
メッセージタイプを取得します(受信用)。
|
| 戻り値 |
メッセージタイプ
| OLF_TX_REQ | - | 0x0101 |
| OLF_TX_ACK | - | 0x0102 |
| OLF_TX_REPLY | - | 0x0103 |
| OLF_TX_CONF | - | 0x0104 |
| OLF_TX_CTRL | - | 0x0206 |
|
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.57. SetuchRetid
| 名称 |
SetuchRetid - リターンコードを設定する |
| 形式 |
void SetuchRetid(unsigned char uchRetid)
|
| 説明 |
リターンコードを設定します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.58. GetuchRetid
| 名称 |
GetuchRetid - リターンコードを取得する |
| 形式 |
unsigned char GetuchRetid()
|
| 説明 |
リターンコードを取得します(受信用)。
|
| 戻り値 |
リターンコード |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.59. SetuchDfind
| 名称 |
SetuchDfind - 通信制御情報を設定する |
| 形式 |
void SetuchDfind(unsigned char uchDfind)
|
| 説明 |
通信制御情報を設定します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.60. GetuchDfind
| 名称 |
GetuchDfind - 通信制御情報を取得する |
| 形式 |
unsigned char GetuchDfind()
|
| 説明 |
通信制御情報を取得します。
|
| 戻り値 |
通信制御情報 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.61. SetulDetail
| 名称 |
SetulDetail - 詳細情報を設定する |
| 形式 |
void SetulDetail(unsigned long ulDetail)
|
| 説明 |
詳細情報を設定します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.62. GetulDetail
| 名称 |
GetulDetail - 詳細情報を取得する |
| 形式 |
unsigned long GetulDetail()
|
| 説明 |
詳細情報を取得します(受信用)。
|
| 戻り値 |
詳細情報 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.63. SetchSourceID
| 名称 |
SetchSourceID - 端末識別子を設定する |
| 形式 |
void SetchSourceID(char* pchSourceID)
|
| 説明 |
端末識別子を設定します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.64. GetchSourceID
| 名称 |
GetchSourceID - 端末識別子を取得する |
| 形式 |
void GetchSourceID(char* pchSourceID,unsigned int iLength)
|
| 説明 |
端末識別子を取得します。
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.65. SetlLReasonCode
| 名称 |
SetlLReasonCode - 論理パス接続結果理由を設定する |
| 形式 |
void SetlLReasonCode(long lLReasonCode)
|
| 説明 |
論理パス接続結果理由を設定します。
| lLReasonCode | - | 論理パス接続結果理由 |
|
| 戻り値 |
ありません。 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |
2.1.1.66. GetlLReasonCode
| 名称 |
GetlLReasonCode - 論理パス接続結果理由を取得する |
| 形式 |
long GetlLReasonCode()
|
| 説明 |
論理パス接続結果理由を取得します。
|
| 戻り値 |
論理パス接続結果理由 |
| エラー |
ありません。 |
| 関連項目 |
ありません。 |