TP1ConnectionManager

〈このページの構成〉

TP1ConnectionManagerの概要
コンストラクタの詳細
プロパティの詳細
メソッドの詳細

TP1ConnectionManagerの概要

名前空間

Hitachi.OpenTP1.Connector

継承関係

System.Object
  +- Hitachi.OpenTP1.Connector.TP1ConnectionManager

説明

TP1ConnectionManagerクラスは，OpenTP1との対話に必要なさまざまなオブジェクト（コネクション，レコードなど）を取得する機能を提供します。

コンストラクタの一覧

名称	説明
TP1ConnectionManager()	TP1ConnectionManagerクラスのインスタンスを初期化します。
TP1ConnectionManager(System.String)	TP1ConnectionManagerクラスのインスタンスを初期化します。

プロパティの一覧

名称	説明
LogWriter	ログの出力先になるTextWriterオブジェクトを設定および取得します。
ProfileID	このオブジェクトに設定されているプロファイルIDを取得します。

メソッドの一覧

名称	説明
CreateIndexedRecord(System.String)	リモートプロシジャコール（RPC）機能を実行する場合に，入力電文および出力電文を格納するためのIndexedRecordオブジェクトを取得します。
GetConnection()	OpenTP1にアクセスするためのConnectionオブジェクトを取得します。
GetMessageBuffer(System.Int32)	インデクスドレコードを使用してリモートプロシジャコール（RPC）機能を実行する場合に，利用するバッファをプールから取得します。
GetTcpipConnection()	TCP/IP通信を実行するためのTcpipConnectionオブジェクトを取得します。

ページの先頭へ

コンストラクタの詳細

●TP1ConnectionManager

説明

TP1ConnectionManagerクラスのインスタンスを初期化します。

宣言

【C#の場合】

public TP1ConnectionManager(
);

【Visual Basicの場合】

Public New( _
)

【J#の場合】

public TP1ConnectionManager(
);

【COBOL言語の場合】

IDENTIFICATION DIVISION.
AUTO-METHOD. CONSTRUCTOR.
DATA DIVISION.
LINKAGE SECTION.
PROCEDURE DIVISION.
END AUTO-METHOD.

パラメタ

なし

例外

なし

注意事項

TP1ConnectionManagerクラスのインスタンスを初期化します。

初期化時にこのオブジェクトから生成される各オブジェクトは構成ファイルに記述された<common>要素内の情報を利用します。

構成ファイルの<common>要素内に情報が存在しない場合はデフォルト値を利用します。

●TP1ConnectionManager

説明

TP1ConnectionManagerクラスのインスタンスを初期化します。

宣言

【C#の場合】

public TP1ConnectionManager(
  string profileId
);

【Visual Basicの場合】

Public New( _
  ByVal profileId As String _
)

【J#の場合】

public TP1ConnectionManager(
  System.String profileId
);

【COBOL言語の場合】

IDENTIFICATION DIVISION.
AUTO-METHOD. CONSTRUCTOR.
DATA DIVISION.
LINKAGE SECTION.
01 profileId USAGE STRING.
PROCEDURE DIVISION USING BY VALUE profileId.
END AUTO-METHOD.

パラメタ

profileId

このオブジェクトに割り当てる構成ファイルのプロファイルIDを設定します。

""が設定された場合は<common>要素のプロファイル情報を使用します。

nullが設定された場合は引数を持たないコンストラクタと同様の動作をします。

例外

Hitachi.OpenTP1.Connector.TP1ConnectorException: 構成ファイルに存在しないプロファイルIDが設定されました。

注意事項

TP1ConnectionManagerクラスのインスタンスを初期化します。

構成ファイルに記述されたプロファイルの<profile>要素内の情報を使用します。

プロファイルIDとして""が設定された場合は<common>要素のプロファイル情報を使用します。

nullが設定された場合は引数を持たないコンストラクタと同様の動作をします。

ページの先頭へ

プロパティの詳細

●LogWriter

説明

ログの出力先になるTextWriterオブジェクトを設定および取得します。

宣言

【C#の場合】

public System.IO.TextWriter LogWriter {get; set;}

【Visual Basicの場合】

Public Property LogWriter As System.IO.TextWriter

【J#の場合】

public System.IO.TextWriter get_LogWriter();
public void set_LogWriter(System.IO.TextWriter);

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
  CLASS TEXTWRITER AS ‘System.IO.TextWriter’.
IDENTIFICATION DIVISION.
METHOD-ID. GET PROPERTY LogWriter IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE IS OBJECT REFERENCE TEXTWRITER.
PROCEDURE DIVISION RETURNING VAL.
END METHOD.
 
IDENTIFICATION DIVISION.
METHOD-ID. SET PROPERTY LogWriter IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE IS OBJECT REFERENCE TEXTWRITER.
PROCEDURE DIVISION USING BY VALUE VAL.
END METHOD.

例外

Hitachi.OpenTP1.Connector.TP1ConnectorException: ログの出力先としてnullが設定されました。

注意事項

このプロパティを設定した場合，Connector .NETは設定されたTextWriterオブジェクトに対してログ出力処理ごとにはFlush処理をしません。そのため，TextWriterオブジェクトの用途やTextWriterオブジェクトの種類に応じて，Flush処理やClose処理を適切に行ってください。

●ProfileID

説明

このオブジェクトに設定されているプロファイルIDを取得します。

宣言

【C#の場合】

public string ProfileID {get;}

【Visual Basicの場合】

Public ReadOnly Property ProfileID As String

【J#の場合】

public System.String get_ProfileID();

【COBOL言語の場合】

IDENTIFICATION DIVISION.
METHOD-ID. GET PROPERTY ProfileID IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE STRING.
PROCEDURE DIVISION RETURNING VAL.
END METHOD.

例外

なし

ページの先頭へ

メソッドの詳細

●CreateIndexedRecord

説明

リモートプロシジャコール（RPC）機能を実行する場合に，入力電文および出力電文を格納するためのIndexedRecordオブジェクトを取得します。

宣言

【C#の場合】

public Hitachi.OpenTP1.Connector.IndexedRecord
 CreateIndexedRecord(
  string recordName
);

【Visual Basicの場合】

Public Function CreateIndexedRecord( _
  ByVal recordName As String _
) As Hitachi.OpenTP1.Connector.IndexedRecord

【J#の場合】

public Hitachi.OpenTP1.Connector.IndexedRecord
 CreateIndexedRecord(
  System.String recordName
);

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
  CLASS INDEXEDRECORD AS ‘Hitachi.OpenTP1.Connector.IndexedRecord’.
IDENTIFICATION DIVISION.
METHOD-ID. CreateIndexedRecord PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 recordName USAGE IS STRING.
01 RESULT USAGE IS OBJECT REFERENCE INDEXEDRECORD.
PROCEDURE DIVISION USING BY VALUE recordName RETURNING RESULT.
END METHOD CreateIndexedRecord.

パラメタ

recordName: IndexedRecordオブジェクトのレコード名を設定します。

戻り値

指定されたレコード名が設定されたIndexedRecordオブジェクトを返します。

例外

なし

注意事項

リモートプロシジャコール（RPC）機能を実行する場合に，入力電文および出力電文を格納するためのIndexedRecordオブジェクトを取得します。

●GetConnection

説明

OpenTP1にアクセスするためのConnectionオブジェクトを取得します。

コネクションプールに存在している場合は，プールから取り出します。

存在しない場合は，新規にConnectionオブジェクトを生成します。

宣言

【C#の場合】

public Hitachi.OpenTP1.Connector.TP1Connection
 GetConnection(
);

【Visual Basicの場合】

Public Function GetConnection( _
) As Hitachi.OpenTP1.Connector.TP1Connection

【J#の場合】

public Hitachi.OpenTP1.Connector.TP1Connection
 GetConnection(
);

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
  CLASS TP1CONNECTION AS ‘Hitachi.OpenTP1.Connector.TP1Connection’.
IDENTIFICATION DIVISION.
METHOD-ID. GetConnection PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 RESULT USAGE IS OBJECT REFERENCE TP1CONNECTION.
PROCEDURE DIVISION RETURNING RESULT.
END METHOD GetConnection.

パラメタ

なし

戻り値

OpenTP1と対話を行うためのコネクションが返されます。

例外

Hitachi.OpenTP1.Connector.TP1ConnectorException: コネクションの取得に失敗しました。

注意事項

取得したTP1Connectionオブジェクトを利用してOpenTP1との対話を行えます。

●GetMessageBuffer

説明

インデクスドレコードを使用してリモートプロシジャコール（RPC）機能を実行する場合に，利用するバッファをプールから取得します。

宣言

【C#の場合】

public Hitachi.OpenTP1.Connector.MessageBuffer
 GetMessageBuffer(
  int buffersize
);

【Visual Basicの場合】

Public Function GetMessageBuffer( _
  ByVal buffersize As Integer _
) As Hitachi.OpenTP1.Connector.MessageBuffer

【J#の場合】

public Hitachi.OpenTP1.Connector.MessageBuffer
 GetMessageBuffer(
  int buffersize
);

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
  CLASS MESSAGEBUFFER AS ‘Hitachi.OpenTP1.Connector.MessageBuffer’.
IDENTIFICATION DIVISION.
METHOD-ID. GetMessageBuffer PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 buffersize USAGE IS BINARY-LONG.
01 RESULT USAGE IS OBJECT REFERENCE MESSAGEBUFFER.
PROCEDURE DIVISION USING BY VALUE buffersize RETURNING RESULT.
END METHOD GetMessageBuffer.

パラメタ

buffersize: 利用するバッファのサイズを設定します。

戻り値

設定されたサイズより大きく，かつ最も近いサイズのバッファを返します。

例外

Hitachi.OpenTP1.Connector.TcnIllegalArgumentException: 指定されたバッファ長が0以下であるか，または最大長を超えています。
Hitachi.OpenTP1.Connector.TcnNotUsedException: 構成ファイルの設定でメッセージバッファの利用が無効です（<buffer>要素のpooling属性がtrueではありません）。

注意事項

インデクスドレコードを使用してリモートプロシジャコール（RPC）機能を実行する場合に，利用するバッファをプールから取得します。

バッファを取得する場合に，バッファのサイズを設定します。

設定されたサイズより大きく，かつ最も近いサイズのバッファを返します。

●GetTcpipConnection

説明

TCP/IP通信を実行するためのTcpipConnectionオブジェクトを取得します。

コネクションプールに存在している場合はプールから取り出します。

存在しない場合は，新規にTcpipConnectionオブジェクトを生成します。

宣言

【C#の場合】

public Hitachi.OpenTP1.Connector.TP1Connection
 GetTcpipConnection(
);

【Visual Basicの場合】

Public Function GetTcpipConnection( _
) As Hitachi.OpenTP1.Connector.TP1Connection

【J#の場合】

public Hitachi.OpenTP1.Connector.TP1Connection
 GetTcpipConnection(
);

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
  CLASS TCPIPCONNECTION AS ‘Hitachi.OpenTP1.Connector. TcpipConnection’.
IDENTIFICATION DIVISION.
METHOD-ID. GetTcpipConnection PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 RESULT USAGE IS OBJECT REFERENCE TCPIPCONNECTION.
PROCEDURE DIVISION RETURNING RESULT.
END METHOD GetTcpipConnection.

パラメタ

なし

戻り値

TCP/IP通信を実行するためのコネクションが返されます。

例外

Hitachi.OpenTP1.Connector.TP1ConnectorException: コネクションの取得に失敗しました。

注意事項

取得したTcpipConnectionオブジェクトを利用してTCP/IP通信を実行できます。

ページの先頭へ