セクション 3(cbl) - COBOL 関数

ドキュメントのダウンロード

サイトマップ

用語集

検索

e-docs > Tuxedo > Tuxedo COBOL リファレンス > セクション 3(cbl) - COBOL 関数

Tuxedo COBOL リファレンス

TPRECV(3cbl)

名前

TPRECV()－会話接続でメッセージを受信する

形式

01 TPSVCDEF-REC.
 COPY TPSVCDEF. 
 
01 TPTYPE-REC.
 COPY TPTYPE. 
 
01 DATA-REC.
 COPY User data. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS.
 
CALL "TPRECV" USING TPSVCDEF-REC TPTYPE-REC DATA-REC TPSTATUS-REC.

機能説明

TPRECV() は、別のプログラムからオープン接続を介してデータを受け取るときに使用します。COMM-HANDLE は、データを受け取るオープン接続を指定します。COMM-HANDLE は、TPCONNECT() または TPSVCSTART() から返される通信ハンドルです。DATA-REC は、メッセージが読み込まれる場所を指定し、入力時には LEN が DATA-REC に移動される最大バイト数を示します。

正常終了の場合、およびいくつかのイベント・タイプの場合、LEN には DATA-REC に移動された実際のバイト数が入ります。REC-TYPE および SUB-TYPE には、それぞれデータのタイプおよびサブタイプが入っています。メッセージが DATA-REC より大きい場合は、DATA-REC にはこのレコードに入るバイト数分のみが入ります。応答の残りは破棄され、TPRECV() は TPTRUNCATE を設定します。

正常終了時に LEN が 0 である場合は、応答にはデータ部がなく、DATA-REC は変更されていません。入力時に LEN を 0 にすると、エラーになります。

TPRECV() は、接続の制御を持たないプログラムしか出せません。

次に、TPSVCDEF-REC の有効な設定の一覧を示します。

TPNOCHANGE

この設定を使用すると、DATA-REC のタイプは変更できません。すなわち、受信したメッセージのタイプとサブタイプは、それぞれ REC-TYPE および SUB-TYPE と一致しなければなりません。TPNOCHANGE または TPCHANGE のいずれかが設定されていなければなりません。

TPCHANGE

受信したメッセージのタイプとサブタイプの両方または片方は、受け取り側が着信レコードのタイプを識別するかぎりは、それぞれ REC-TYPE および SUB-TYPE で指定されているものと異なっていることが可能です。TPNOCHANGE または TPCHANGE のいずれかが設定されていなければなりません。

TPNOBLOCK

TPRECV() はデータが到着するまで待機します。すでにデータが受信できる状態であると、TPRECV() はデータを取り込んで終了します。TPNOBLOCK または TPBLOCK のいずれかが設定されていなければなりません。

TPBLOCK

TPBLOCK が設定されていて、データが受信できる状態である場合は、呼び出し元は、データが到着するまでブロックします。TPNOBLOCK または TPBLOCK のいずれかが設定されていなければなりません。

TPNOTIME

この設定は、呼び出し元が無制限にブロックでき、ブロッキング・タイムアウトの影響を受けないようにすることを指定します。ただし、トランザクション・タイムアウトは引き続きプログラムに対して有効です。TPNOTIME または TPTIME のいずれかが設定されていなければなりません。

TPTIME

このフラグは、ブロッキング条件が存在し、ブロッキング時間に達すると、呼び出し元がブロッキング・タイムアウトを受け取ることを示します。TPNOTIME または TPTIME のいずれかが設定されていなければなりません。

TPSIGRSTRT

ルーチン内部のシステム・コールがシグナルによって中断された場合、呼び出しが再度出されます。TPNOSIGRSTRT または TPSIGRSTRT のいずれかが設定されていなければなりません。

TPNOSIGRSTRT

ルーチン内部のシステム・コールがシグナルによって中断された場合、中断されたシステム・コールは再開されず、この呼び出しは異常終了します。TPNOSIGRSTRT または TPSIGRSTRT のいずれかが設定されていなければなりません。

通信ハンドル COMM-HANDLE に対してイベントが存在する場合、TPRECV() は終了し、TP-STATUS に TPEEVENT() を設定します。イベントのタイプは、TPEVENT() に返されます。TPEV-SVCSUCC、TPEV-SVCFAIL および TPEV-SENDONLY イベントとともに、データを受け取ることができます。TPRECV() の有効なイベントを次に示します。

TPEV-DISCONIMM

会話の従属側が受け取るこのイベントは、その会話の起動元が TPDISCON() により即時切断要求を出したこと、または、会話の起動元がまだオープンしている接続について TPRETURN() または TPCOMMIT() を出したときにエラーが発生したことを示します。このイベントは、通信エラー (サーバ、マシン、ネットワークの障害など) により接続が切断されたときにも起動元またはその従属側に返されます。これは即時切断通知 (つまり、正常ではなく中途の終了) であるため、処理途中のデータは失われます。2 つのプログラムが同じトランザクションに参加していた場合、そのトランザクションは中途終了マークが付けられます。COMM-HANDLE は無効になります。

TPEV-SENDONLY

接続の他方の側にあるプログラムは、接続の制御を放棄しました。このイベントの受信側はデータを送信することはできますが、制御権を放棄するまではデータを受信することはできません。

TPEV-SVCERR

このイベントは、会話の起動元が受け取るもので、会話の従属側が TPRETURN() を出したことを示します。TPRETURN() によって、サービスが正常に終了できないようなエラーが検出されました。たとえば、不正な引数が TPRETURN() に渡されていたり、TPRETURN() が、そのサービスが別の従属側にオープン接続を持っている最中に呼び出されている可能性があります。このイベントの性質上、アプリケーションが定義したデータや戻りコードは返されません。この接続は切断され、COMM-HANDLE は無効になります。このイベントが、受信側のトランザクションの一部として発生すると、そのトランザクションに中途終了マークが付けられます。

TPEV-SVCFAIL

このイベントは、会話の起動元が受け取るもので、会話の他方の側の下位サービスがアプリケーションで定義されるとおり正常に終了しなかったことを示します。つまり、TPRETURN() が TPFAIL() または TPEXIT() を設定して呼び出されています。TPRETURN() が呼び出されたときに従属サービスがこの接続の制御権をもっている場合、アプリケーションで定義されている戻り値およびレコードを接続の起動元に渡すことができます。サービス・ルーチンの終了処理の一部として、サーバはこの接続を切断しています。このため、COMM-HANDLE は無効になります。このイベントが、受信側のトランザクションの一部として発生すると、そのトランザクションに中途終了マークが付けられます。

TPEV-SVCSUCC

このイベントは、会話の起動元が受け取るもので、会話の他方の側の下位サービスがアプリケーションで定義されるとおり正常に終了したことを示します。つまり、TPRETURN() が TPSUCCESS() を設定して呼び出されています。サービス・ルーチンの終了処理の一部として、サーバはこの接続を切断しています。このため、COMM-HANDLE は無効になります。受信側がトランザクション・モードにいる場合、そのトランザクションをコミットする (それが起動元でもある場合) か、中途終了して、サーバが行った作業内容 (トランザクション・モードである場合) をコミットあるいは中途終了させます。

戻り値

TPRECV() は正常終了時には、TP-STATUS に [TPOK] を設定します。TP-STATUS に [TPEEVENT] が設定され、TPEVENT() が TPEV-SVCSUCC または TPEV-SVCFAIL の場合、APPL-RETURN-CODE には、TPRETURN() の一部として送信されたアプリケーション定義の値が入ります。着信メッセージの大きさが入力時に LEN に指定されたより大きい場合、TPTRUNCATE() が設定され、LEN 分のデータのみが DATA-REC に移動されて残りのデータは破棄されます。