TcpipConnection
- 〈このページの構成〉
TcpipConnectionの概要
名前空間
Hitachi.OpenTP1.Connector
継承関係
System.Object +- Hitachi.OpenTP1.Connector.TcpipConnection
実装インタフェース
Hitachi.OpenTP1.Connector.ITP1Connection
System.IDisposable
説明
TcpipConnectionクラスは,MHPまたは他システムとTCP/IP通信を行う機能を提供します。
メソッドの一覧
名称 |
説明 |
---|---|
接続中の物理コネクションを解放します。 |
|
コネクションをコネクションプールに戻します。 |
|
Execute(Hitachi.OpenTP1.Connector.TcpipInfo, Hitachi.OpenTP1.IRecord, Hitachi.OpenTP1.IRecord) |
TCP/IP通信を実行します。 |
メソッドの詳細
●Disconnect
- 説明
-
接続中の物理コネクションを解放します。
- 宣言
-
- 【C#の場合】
public void Disconnect( );
- 【Visual Basicの場合】
Public Sub Disconnect( _ )
- 【J#の場合】
public void Disconnect( );
- 【COBOL言語の場合】
IDENTIFICATION DIVISION. METHOD-ID. Disconnect PUBLIC. DATA DIVISION. LINKAGE SECTION. PROCEDURE DIVISION. END METHOD Disconnect.
- パラメタ
-
なし
- 戻り値
-
なし
- 例外
-
なし
- 注意事項
-
接続中のすべての物理コネクションを解放します。
内部で保持しているTP1ClientオブジェクトにCloseRpcメソッドを発行します。
そのため,同じプロファイルIDでTP1Connectionと併用している場合には,常設コネクションもクローズされます。
●Dispose
- 説明
-
コネクションをコネクションプールに戻します。
- 宣言
-
- 【C#の場合】
public sealed virtual void Dispose( );
- 【Visual Basicの場合】
Public Overrides NotOverridable Overridable Sub Dispose( _ )
- 【J#の場合】
public final void Dispose( );
- 【COBOL言語の場合】
IDENTIFICATION DIVISION. METHOD-ID. Dispose PUBLIC IS FINAL. DATA DIVISION. LINKAGE SECTION. PROCEDURE DIVISION. END METHOD Dispose.
- パラメタ
-
なし
- 戻り値
-
なし
- 例外
-
なし
- 注意事項
-
コネクションをコネクションプールに戻します。
コネクションをコネクションプールに戻したあと,このオブジェクトに対してさまざまな処理を実行するとTP1ConnectorExceptionがスローされます。
●Execute
- 説明
-
TCP/IP通信を実行します。
- 宣言
-
- 【C#の場合】
public System.Boolean Execute( Hitachi.OpenTP1.Connector.TcpipInfo tcpipInfo, Hitachi.OpenTP1.IRecord input, Hitachi.OpenTP1.IRecord output );
- 【Visual Basicの場合】
Public Function Execute( _ ByVal tcpipInfo As Hitachi.OpenTP1.Connector.TcpipInfo, _ ByVal input As Hitachi.OpenTP1.IRecord, _ ByVal output As Hitachi.OpenTP1.IRecord _ ) As System.Boolean
- 【J#の場合】
public System.Boolean Execute( Hitachi.OpenTP1.Connector.TcpipInfo tcpipInfo, Hitachi.OpenTP1.IRecord input, Hitachi.OpenTP1.IRecord output );
- 【COBOL言語の場合】
ENVIRONMENT DIVISION. CONFIGURATION SECTION. REPOSITORY. CLASS TCPIPINFO AS ‘Hitachi.OpenTP1.Connector.TcpipInfo’. CLASS IRECORD AS ‘Hitachi.OpenTP1.IRecord’. IDENTIFICATION DIVISION. METHOD-ID. Execute PUBLIC. DATA DIVISION. LINKAGE SECTION. 01 tcpipInfo USAGE IS OBJECT REFERENCE TCPIPINFO. 01 input USAGE OBJECT REFERENCE IRECORD. 01 output USAGE OBJECT REFERENCE IRECORD. 01 output USAGE IS LOGICAL. PROCEDURE DIVISION USING BY VALUE tcpipInfo BY VALUE input BY VALUE output RETURNING output. END METHOD Execute.
- パラメタ
-
- tcpipInfo
-
TCP/IP通信を実行するために必要なさまざまな情報(通信形態,タイムアウト値など)を設定したTcpipInfoオブジェクトを設定します。
- input
-
入力用の情報を格納したIRecordオブジェクトを設定します。
- output
-
出力用の情報を格納したIRecordオブジェクトを設定します。
- 戻り値
-
TCP/IP通信に成功した場合はtrueが返されます。
また,同期送受信または一方受信の場合はoutputに受信電文の内容を設定します。
- 例外
-
- Hitachi.OpenTP1.Connector.TP1ConnectorException
-
次のどれかの場合に発生します。
-
コネクションがすでに閉じられています。
-
指定された引数が不正です。
-
TCP/IP通信の実行に失敗しました。
-
- 注意事項
-
Executeメソッドは,inputに指定された内容を入力電文として,またoutputに指定された内容を出力電文としてTcpipInfoのプロパティ値に従って,TCP/IP通信を実行します。
一方送信の場合,outputの指定は無視されます。
一方受信の場合,inputの指定は無視されます。
一方受信および同期送受信の場合,outputに指定されたIRecordオブジェクトの持つ長さが受信電文サイズと見なされます。受信電文サイズ分を受信するまで,Executeメソッドは呼び出せません。