MessageBuffer

MessageBufferの概要

名前空間

Hitachi.OpenTP1.Connector

継承関係

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

説明

MessageBufferクラスはインデクスドレコードの入出力電文の電文保持領域として内部にバッファを持ちます。保持しているバッファはTP1ConnectionManagerクラスが管理しているバッファプールから割り当てられたものです。

プロパティの一覧

名称説明
Bufferメッセージバッファ内に保持しているバッファの参照を返します。
BufferSizeメッセージバッファに保持しているバッファのサイズを取得します。
MessageLengthメッセージバッファが保持しているメッセージ長を取得および設定します。

メソッドの一覧

名称説明
Append(Hitachi.OpenTP1.Connector.MessageBuffer)指定されたメッセージバッファのデータを,メッセージバッファが保持するバッファにコピーします。
Append(System.Byte[])指定されたバイト配列のデータをメッセージバッファが保持するバッファにコピーします。
ReleaseMessageBuffer()メッセージバッファ内に保持しているバッファをTP1ConnectionManagerクラスが管理しているプールに返します。

プロパティの詳細

Buffer

説明
メッセージバッファ内に保持しているバッファの参照を返します。
宣言
【C#の場合】

public virtual byte[] Buffer {get;}

【Visual Basicの場合】

Public Overridable ReadOnly Property Buffer As Byte()

【J#の場合】

public ubyte[] get_Buffer();

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
 CLASS BYTE-ARRAY AS ‘System.Byte’ IS ARRAY.
IDENTIFICATION DIVISION.
METHOD-ID. GET PROPERTY Buffer IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE IS OBJECT REFERENCE BYTE-ARRAY.
PROCEDURE DIVISION RETURNING VAL.
END METHOD.

例外
なし

 

BufferSize

説明
メッセージバッファに保持しているバッファのサイズを取得します。
宣言
【C#の場合】

public virtual int BufferSize {get;}

【Visual Basicの場合】

Public Overridable ReadOnly Property BufferSize As Integer

【J#の場合】

public int get_BufferSize();

【COBOL言語の場合】

IDENTIFICATION DIVISION.
METHOD-ID. GET PROPERTY BufferSize IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE BINARY-LONG.
PROCEDURE DIVISION RETURNING VAL.
END METHOD.

例外
なし

 

MessageLength

説明
メッセージバッファが保持しているメッセージ長を取得および設定します。
宣言
【C#の場合】

public virtual int MessageLength {get; set;}

【Visual Basicの場合】

Public Overridable Property MessageLength As Integer

【J#の場合】

public int get_MessageLength();
public void set_MessageLength(int);

【COBOL言語の場合】

IDENTIFICATION DIVISION.
METHOD-ID. GET PROPERTY MessageLength IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE BINARY-LONG.
PROCEDURE DIVISION RETURNING VAL.
END METHOD.

IDENTIFICATION DIVISION.
METHOD-ID. SET PROPERTY MessageLength IS PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 VAL USAGE BINARY-LONG.
PROCEDURE DIVISION USING BY VALUE VAL.
END METHOD.

例外
Hitachi.OpenTP1.Connector.TcnIllegalArgumentException
次のどれかの場合に発生します。
  • バッファがnullの場合
  • 指定されたメッセージ長が1未満の場合
  • バッファの長さより長い場合

 

メソッドの詳細

Append

説明
指定されたメッセージバッファのデータを,メッセージバッファが保持するバッファにコピーします。
宣言
【C#の場合】

public virtual void Append(
 Hitachi.OpenTP1.Connector.MessageBuffer message
);

【Visual Basicの場合】

Public Overridable Sub Append( _
 ByVal message As _
 Hitachi.OpenTP1.Connector.MessageBuffer _
)

【J#の場合】

public void Append(
 Hitachi.OpenTP1.Connector.MessageBuffer message
);

【COBOL言語の場合】

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

パラメタ
message
設定するメッセージ。
戻り値
なし
例外
Hitachi.OpenTP1.Connector.TcnIllegalArgumentException
電文がnullです。
Hitachi.OpenTP1.Connector.TcnIllegalStateException
バッファがnullの場合,または電文長がバッファのサイズを超える場合に発生します。

 

Append

説明
指定されたバイト配列のデータをメッセージバッファが保持するバッファにコピーします。
宣言
【C#の場合】

public virtual void Append(
 byte[] message
);

【Visual Basicの場合】

Public Overridable Sub Append( _
 ByVal message() As Byte _
)

【J#の場合】

public void Append(
 ubyte[] message
);

【COBOL言語の場合】

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
REPOSITORY.
 CLASS BYTE-ARRAY AS ‘System.Byte’ IS ARRAY.
IDENTIFICATION DIVISION.
METHOD-ID. Append PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
01 message USAGE IS OBJECT REFERENCE BYTE-ARRAY.
PROCEDURE DIVISION USING BY VALUE message.
END METHOD Append.

パラメタ
message
設定するメッセージ。
戻り値
なし
例外
Hitachi.OpenTP1.Connector.TcnIllegalArgumentException
電文がnullです。
Hitachi.OpenTP1.Connector.TcnIllegalStateException
バッファがnullの場合,または電文長がバッファのサイズを超える場合に発生します。

 

ReleaseMessageBuffer

説明
メッセージバッファ内に保持しているバッファをTP1ConnectionManagerクラスが管理しているプールに返します。
宣言
【C#の場合】

public virtual void ReleaseMessageBuffer(
);

【Visual Basicの場合】

Public Overridable Sub ReleaseMessageBuffer( _
)

【J#の場合】

public void ReleaseMessageBuffer(
);

【COBOL言語の場合】

IDENTIFICATION DIVISION.
METHOD-ID. ReleaseMessageBuffer PUBLIC.
DATA DIVISION.
LINKAGE SECTION.
PROCEDURE DIVISION.
END METHOD ReleaseMessageBuffer.

パラメタ
なし
戻り値
なし
例外
なし