ATMI COBOL関数リファレンス

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

COBOLアプリケーション・トランザクション・モニター・インタフェースの紹介

説明

アプリケーション・トランザクション・モニター・インタフェース(ATMI)は、COBOLアプリケーションとトランザクション処理システムとの間に介在し、 ATMIインタフェースと呼ばれています。このマニュアル・ページでは、ATMIインタフェースのCOBOL言語バインディングについて説明します。このインタフェースは、リソースのオープンとクローズ、トランザクションの管理、レコード・タイプの管理、リクエスト/レスポンスや会話サービス・コールの呼び出しなどを行う各種のルーチンで構成されています。

通信パラダイム

ATMIマニュアル・ページに記述されているルーチン群を読めば、これらがコミュニケーションのためのモデルであることが分かります。このモデルは、クライアント・プログラムとサーバー・プログラムがリクエストおよび応答の各メッセージを使用していかにコミュニケートできるかという観点から表現されています。

コミュニケーションの基本的パラダイムとして、リクエスト/レスポンス型と会話型の2つがあります。リクエスト/レスポンス型サービスは、サービス・リクエストとそれに関わるデータによって呼び出されます。リクエスト/レスポンス型サービスは、リクエストを1つだけ受け取ることができ(該当サービス・ルーチンに入った時点で)、かつレスポンスも1つだけ送信することができます(該当サービス・ルーチンから戻った時点で)。一方、会話サービスは接続リクエストによって呼び出されます。このとき、オープンされた接続を参照する手段(つまり、以後の接続ルーチンを呼び出す際に使用されるハンドル)が必要です。接続が確立され、サービス・ルーチンが呼び出されると、以降、接続プログラムあるいは会話型サービスは、その接続が解除されるまでアプリケーションで定義されたようにデータの送受信を行えるようになります。

なお、プログラムはリクエスト/レスポンスと会話によるコミュニケーションのいずれも行うことができますが、両方のサービス・リクエストを受け付けることはできません。以下の項では、これら2種類の通信パラダイムの詳細を説明します。

クライアントおよびサーバーに対するOracle Tuxedoのリクエスト/レスポンス・パラダイム

リクエスト/レスポンスによるコミュニケーションの場合、クライアントはリクエストを送り、応答を受け取ることができる1つのプロセスと定義されています。定義によれば、クライアントはリクエストを受け取ったり、応答を送ったりすることはできません。そのかわり、クライアントはいくつでもリクエストを送ることができ、またそれと同時に応答を待ったり、あるいは適宜ある一定数の応答を受け取ったりすることができます。場合によっては、クライアントは応答を必要としないリクエストを送ることもできます。TPINITIALIZE()とTPTERM()を使用すれば、クライアントはOracle Tuxedo ATMIのアプリケーションと結合および分離することができます。

一方、リクエスト/レスポンス型サーバーは一度に1つのサービス・リクエストを受け取り、そのリクエストに対して1つの応答を返すことができるプログラムと定義されています。サーバーは特定のリクエストを処理しながら、一方でリクエスト/レスポンス型リクエストあるいは会話型リクエストを出し、それらの応答を受け取ることにより、クライアントのように働くこともできます。サーバーはこうした能力の故に、リクエスタと呼ばれることもあります。ただし、クライアント・プログラムとサーバー・プログラムはどちらもリクエスタになることができます(実際、クライアントはリクエスタ以外の何物でもありません)。

リクエスト/レスポンス型サーバーは別のリクエスト/レスポンス型サーバーにリクエストを送る(転送する)ことができます。この場合、最初のサーバーは受け取ったリクエストを別のサーバーに渡すだけで、応答を受け取ることは期待しません。この連鎖の中の最後のサーバーがそのリクエストに対する応答をもとのリクエスタに送ります。この転送ルーチンの利用によって、もとのリクエスタは最終的にその応答を受け取ることができるのです。

サーバーとサービス・ルーチンの利用から、Oracle Tuxedo ATMIアプリケーションの作成に構造化手法をとることが可能になります。サーバーでは、アプリケーション作成者は、リクエストの受信や応答の送信といったコミュニケーションの詳細ではなく、サービスによって実行する事柄に関する作業に専念すればよいのです。コミュニケーション上の詳細の多くはOracle Tuxedoシステムが処理するため、サービス・ルーチンを作成するときにはある一定の規則に従う必要があります。サーバーは、そのサービス・ルーチンを終了する時点で、TPRETURN()を使用して応答を送ったり、あるいはTPFORWAR()を使用してリクエストを転送したりできます。サービスはその他の作業を行ったり、この時点以後別のプログラムとコミュニケートすることは許されません。そのため、サーバーが実行するサービスは、リクエストが受け取られたときに開始され、応答が送信あるいはリクエストが転送された時点で終了します。

リクエスト・メッセージと応答メッセージとの間には、本質的に異なる点があります。リクエストにはそれが送信される以前には関連するコンテキストはありませんが、応答にはあるという点です。たとえば、ある要求を送る際に、呼出し側はアドレッシング情報を与えなければなりませんが、応答は常にその要求を出したプログラムに返されます。つまり、応答の場合には、要求が出されるときに与えられたアドレッシング情報が維持されていて、応答の送信側はそのあて先になんら手を加えることはできません。この両者の相違点については、TPCALL()のルーチンのパラメータと説明で明らかにされています。

リクエスト・メッセージはその送信時に特定の優先度が付与されます。この優先度にしたがって、リクエストはキューから取り出されます。つまり、サーバーはキューの中で最も優先度の高いリクエストから順に取り出すのです。ただし、リクエストがいつまでもキューの中に残されてしまうのを防ぐために、優先度に関係なく、最も長くキューに入っているリクエストが一定間隔で取り出されます。デフォルト設定では、リクエストの優先度はそのリクエストが送られるサービス名に対応させて付けられます。サービス名にはシステムの構成時に優先度を与えることができます(「UBBCONFIG(5)」参照)。特に定義されていない場合には、デフォルトの優先度が使用されます。この優先度は、TPCALL()に説明のあるルーチン(TPSPRIO())を使用して実行時に設定することができます。呼出し側はこの方法により、メッセージ送信時に構成またはデフォルトの優先度を変更できます。

クライアントおよびサーバーに対するOracle Tuxedoシステムの会話パラダイム

会話型のコミュニケーションの場合、クライアントは、会話接続を行うことはできるが、接続リクエストを受け付けることはできないプログラムと定義されています。

一方、会話サーバーは、接続リクエストを受け取ることができるプログラムです。接続が確立され、サービス・ルーチンが呼び出されると、以降、接続プログラムあるいは会話型サービスは、その接続が解除されるまでアプリケーションで定義されたようにデータの送受信を行えるようになります。会話は半二重方式で行われます。つまり、接続の一方の側が制御権をもってデータを送信し、他方の側は制御権を渡されるまではデータを送信できません。接続が確立されている間、サーバーは「予約状態」になり、他のプログラムがそのサーバーとの間で接続を確立することはできません。

リクエスト/レスポンス型サーバーの場合と同様、会話型サーバーは他のリクエストを出したり、他のサーバーとの接続を行うことによりリクエスタとして機能できます。一方、リクエスト/レスポンス型サーバーと異なり、会話サーバーはリクエストを別のサーバーに転送することはできません。このため、会話サーバーによって実行される会話サービスは、リクエストを受け取った時点で開始され、TPRETURN()を介して最終的な応答が送信された時点で終了します。

接続が確立されると、通信ハンドルは参加者のためのアドレッシング情報に関して必要となる任意のコンテキストを暗示します。メッセージは、アプリケーション側の規定に従って送受信することができます。リクエスト・メッセージ応答メッセージとの間には本質的な相違はなく、またメッセージの優先度に関する規定もありません。

SYSTEM/Tのキュー式メッセージ・モデル

Oracle Tuxedo ATMIのキュー・メッセージ・モデルは、リクエスト・メッセージの完了を待たず、そのメッセージが後で処理されるようにキューに登録し、またオプションとしてキューに入れられたレスポンス・メッセージを介して応答が得られるようにします。メッセージをキューに登録したりレスポンスをキューから取り出すためのATMI関数は、TPENQUEUE()とTPDEQUEUE()です。これらの関数は、Oracle Tuxedo ATMIのアプリケーション・プロセスの全ての型(クライアント、サーバー、会話型)のいずれのプロセスからも呼び出せます。

キュー・メッセージ機能は、XA準拠のリソース・マネージャで提供されます。永続的なメッセージはトランザクション内でキューへの登録および取出しが行われ、高い信頼性で一度に処理されます。

ATMIトランザクション

Oracle Tuxedoシステムは、トランザクションの定義および管理について、相互に排他的な2つの関数をサポートしています。Oracle TuxedoシステムのATMIトランザクション境界関数(名前の先頭がTP)とX/OpenのTXインタフェース関数(名前の先頭がTX_)です。X/OpenではTXインタフェースのベースとしてATMIのトランザクション境界関数が使用されるので、TXインタフェースの構文およびセマンティクスは、ATMIとほとんど同じです。この項では、ATMIのトランザクション概念について概要を述べます。次の項では、TXインタフェースについて補足説明します。

Oracle Tuxedoシステムにおけるトランザクションは、全体としてある結果を導く、あるいは何も結果を示さない1つの論理的な作業単位を定義するときに使用します。トランザクションにより、多くのプロセスによって(そして、おそらく様々な場所で)なされる作業を1つの作業単位として扱うことができます。トランザクションの開始者(開始プロセス)はTPBEGIN()およびTPCOMMIT()またはTPABORT()を使用してトランザクション内での操作内容を記述します。

開始プロセスはまた、TPSUSPEND()を呼び出して現在のトランザクションでの作業を中断することもできます。他のプロセスがTPRESUME()を呼び出して、中断されているトランザクションの開始プロセスの役割を引き継ぐこともできます。トランザクションの開始プロセスとして、プログラムはTPSUSPEND()、TPCOMMIT()、またはTPABORT()のいずれかを呼び出す必要があります。したがって、あるプロセスがトランザクションを終了し、別のプロセスがトランザクションを開始することができます。

サービスを呼び出すプログラムがトランザクション・モードの場合、呼び出されたサービス・ルーチンも同じトランザクションのトランザクション・モードになります。それ以外の場合、サービスがトランザクション・モードで呼び出されるかどうかは、構成ファイルでサービスについて指定されたオプションによって決まります。トランザクション・モードで呼び出されないサービスは、それが呼び出された時点から終了時点までの間に複数のトランザクションを定義できます。一方、トランザクション・モードで呼び出されたサービス・ルーチンは、1つのトランザクションにのみ関与し、終了するまでそのトランザクションでの作業を続けます。なお、接続をトランザクション・モードにアップグレードすることはできません。会話中にTPBEGIN()が呼び出されると、会話はそのトランザクションの外側で維持されます(TPCONNECT()がTPNOTRANを設定して呼び出された場合と同様)。

別のプログラムによって起動されたトランザクションに加わるサービスを、「参加リソース」と呼びます。トランザクションは常に、1つの開始プロセスをもち、かついくつかの参加リソースをもつことができます。同じトランザクションでの作業を行うためにサービスを2回以上呼び出すことができます。TPCOMMIT()またはTPABORT()を呼び出すことができるのは、トランザクションの開始プロセス(つまり、TPBEGIN()またはTPRESUME()のいずれかを呼び出すプログラム)だけです。参加リソースは、TPRETURN()あるいはTPFORWAR()を使用することによりトランザクションの結果に影響を与えます。これらの2つの呼出しはそれぞれ、サービス・ルーチンの終わり、およびそのルーチンがトランザクションの中で担当する部分を終了したことを示すものです。

TXトランザクション

TXインタフェースによって定義されるトランザクションは、ATMI関数によって定義されるトランザクションと実質的に同じです。アプリケーションの開発者は、クライアント・ルーチンおよびサービス・ルーチンを作成するにあたり、どちらの関数でも使用できます。実際、Oracle Tuxedoシステムでは、単一のアプリケーションにおけるクライアント・プログラムおよびサーバー・プログラムすべてに、必ずしもどちらかの1つの関数を使用する必要はありません。ただし、単一のプログラム内で2つの関数を一緒に使用することはできません。たとえば、同じプログラム内でTPBEGIN()を呼び出した後にTXCOMMIT()を呼び出すことはできません。

TXインタフェースには、移植性の高い方法でリソース・マネージャのオープンとクローズを行う2つのコール、TXOPEN()およびTXCLOSE()があります。トランザクションは、TXBEGIN()で開始され、TXCOMMIT()またはTXROLLBACK()のいずれかで完了します。TXINFORM()はトランザクション情報を取り出すために使用されます。また、トランザクションにオプションを設定する3つの呼出しTXSETCOMMITRET()、TXSETTRANCTL()、およびTXSETTIMEOUT()があります。TXインタフェースには、ATMIのTPSUSPEND()とTPRESUME()に相当するものはありません。

TXインタフェースには、ATMIトランザクションについて定義されているセマンティクスおよび規則の他にも、ここで説明しておくべきセマンティクスがいくつかあります。まず、TXインタフェースを使用するサービス・ルーチン開発者は、TXOPEN()を呼び出す独自のTPSVRINIT()ルーチンを使用する必要があります。省略時にOracle Tuxedoシステムが提供するTPSVRINIT()は、TPOPEN()を呼び出します。TPSVRDONE()についても同じことがあてはまります。TXインタフェースを使用している場合は、サービス・ルーチン開発者は、TXCLOSE()を呼び出す独自のTPSVRDONE()を使用しなければなりません。

次に、TXインタフェースには、ATMIにはない別のセマンティクスが2つあります。それは、連鎖および非連鎖トランザクションと、トランザクション特性です。

連鎖および非連鎖トランザクション

TXインタフェースは、トランザクション実行の連鎖モードおよび非連鎖モードをサポートしています。省略時には、クライアント・ルーチンおよびサービス・ルーチンは、非連鎖モードで実行されます。この場合、アクティブなトランザクションが完了した際、新しいトランザクションはTXBEGIN()が呼び出されるまで実行されません。

連鎖モードでは、新しいトランザクションは、現在のトランザクションが完了すると、暗黙に開始されます。つまり、TXCOMMIT()またはTXROLLBACK()が呼び出されると、Oracle Tuxedoシステムは、現在のトランザクションの完了を調整し、制御を呼出し側に返す前に新しいトランザクションを開始します(異常終了の条件によっては、新しいトランザクションを開始できない場合もあります)。

クライアント・ルーチンおよびサービス・ルーチンは、TXSETTRANCTL()を呼び出すことによって連鎖モードのオンとオフを切り替えます。連鎖モードと非連鎖モードの間の移行により、その次のTXCOMMIT()コールまたはTXROLLBACK()コールの動作が変わります。TXSETTRANCTL()の呼出しでは、呼出し側のトランザクション・モードのオンとオフの切替えは行いません。

TXCLOSE()は、呼出し側がトランザクション・モードにあるときには呼び出すことができないため、連鎖モードで実行中の呼出し側がTXCLOSE()を呼び出すには、非連鎖モードに切り替えて、現在のトランザクションを完了してから呼び出さなければなりません。

トランザクション特性

クライアント・ルーチンまたはサービス・ルーチンは、TXINFORM()を呼び出すことによって、そのルーチンのトランザクション特性の現在の値を取得したり、そのルーチンがトランザクション・モードで実行中であるかどうかを判別したりすることができます。

アプリケーション・プログラムの状態には、いくつかのトランザクション特性があります。呼出し側は、TXSET*関数の呼出しによってこれらの特性を指定します。クライアント・ルーチンまたはサービス・ルーチンが特性の値を設定している場合は、異なる値を呼出し側が指定するまでは、その値が有効のままです。呼出し側がTXINFORM()を使用して特性の値を取得しても、これによって値が変更されることはありません。

タイムアウト

Oracle Tuxedo ATMIシステムには3種類のタイムアウトがあります。1つは、トランザクションの開始から終了までの時間に対応します。2つめは、呼出し元に制御が戻るまでブロッキング呼出しがブロック状態になる最長時間に対応します。3つめはサービスのタイムアウトです。これは呼出しの秒数が構成ファイルのSERVICESセクションにおけるSVCTIMEOUTパラメータで指定された秒数を越えた時に発生します。

最初のタイムアウトは、TPBEGIN()を使用してトランザクションを起動するときに指定します(詳細については、TPBEGIN()を参照)。2つめのタイムアウトは、TPCALL()に定義されているOracle Tuxedo ATMIのコミュニケーション・ルーチンを使用する際に発生することがあります。これらのルーチンの呼出し側は一般に、まだ届いていない応答を待っている間はブロック状態になります。これらの呼出し側はデータの送信を行うこともブロックされることがあります(たとえば、リクエスト・キューがいっぱいの場合など)。呼出し側がブロック状態になる最大時間は、Oracle Tuxedo ATMIの構成ファイルに記述されているパラメータによって決まります。詳細については、「UBBCONFIG(5)」のBLOCKTIMEパラメータの項を参照してください。

ブロッキング・タイムアウトは呼出し側がトランザクション・モードにないときにデフォルトの設定によって実行されます。クライアントあるいはサーバーがトランザクション・モードにあると、そのトランザクションが開始したときに指定されたタイムアウト値が働き、UBBCONFIGファイルに指定されているブロッキング・タイムアウト値の影響は受けません。

トランザクション・タイムアウトが発生すると、トランザクション・モードで行われた非同期のリクエストに対する応答は失効状態になることがあります。つまり、あるプログラムがトランザクション・モードで送られたリクエストに対する特定の非同期応答の到着を待っているときに、トランザクション・タイムアウトが発生すると、その応答のハンドルが無効になります。同様に、トランザクション・タイムアウトが発生すると、トランザクションに関連する通信ハンドルに対してイベントが生成され、そのハンドルは無効になります。一方、ブロッキング・タイムアウトが発生した場合、該当するハンドルは無効にならず、応答を待機しているプログラムはその応答を待機するための呼出しを再度出すことができます。

サービス・タイムアウト機構によって、未知の、または予期しないシステム・エラーが原因でフリーズする可能性のあるプロセスについて、システムが強制終了を行うことができます。リクエスト/レスポンス・サービス時にサービス・タイムアウトが発生すると、Oracle Tuxedoシステムによって、フリーズしたサービスを実行中のサーバー・プロセスが強制終了され、エラー・コードTPESVCERRが戻ります。サービス・タイムアウトが会話型サービスで発生した場合は、TPEV_SVCERRイベントが戻ります。

トランザクションがタイムアウトになった場合、トランザクションが中断される前に有効な通信は、TPNOREPLY、TPNOTRAN、およびTPNOBLOCKを設定したTPACALL()の呼び出しだけです。

動的サービス公開

デフォルトの設定では、サーバーのサービスは、サーバーのブート時に公開され、サーバーの停止時にその公開が解除されます。サーバーは、それが提供するサービス・セットに対する制御を実行時に必要とする場合、TPADVERTISE()およびTPUNADVERTISE()を使用します。これらのルーチンは、該当サーバーが複数サーバー/単一キュー・セットに属していないかぎり、呼出し側サーバーが提供するサービスだけに影響します。MSSQセットのサーバーはすべて同じサービス・セットを提供しなければならないため、これらのルーチンもまた呼出し側のMSSQセットを共有するすべてのサーバーの公開に影響します。

型付きレコード

別のアプリケーション・プログラムにデータを送信するために、アプリケーション・プログラムは、まずそのデータをレコードに入れます。インタフェースは、型付きレコードの概念をサポートしています。型付きレコードは、実際には、COBOLの2つのレコードからなります。データ・レコードは、静的領域内に定義され、別のアプリケーション・プログラムに渡すアプリケーション・データが入ります。データ・レコードには、補助型レコードが付加され、異なるマシン・バウンダリ間にまたがってデータ・レコードを渡す際に、Oracle Tuxedoシステムに対し、データ・レコードの解釈と変換の規則を識別します。補助型レコードには、データ・レコードのタイプ、任意選択のサブタイプ、および任意選択のデータ長が入ります。レコード・タイプによっては、特定のレコード・レイアウトなど、サブタイプによる追加の指定が必要となる場合があり、可変長レコードには長さを指定する必要があります。

アプリケーション・プログラマは、サポートされる6つの型付きレコードの中から1つを選択できます。Oracle Tuxedoシステムでは、ユーザー固有の型付きレコードを追加することもできます。詳細は、『Oracle Tuxedo ATMI C関数リファレンス』の「C言語アプリケーション・トランザクション・モニター・インタフェースについて」を参照してください。TPTYPE-REC内のREC-TYPEによって、アプリケーションで送信または受信しようとするレコード・タイプを選択します。さらに細かい分類が必要な場合には、TPTYPE-REC内のSUB-TYPEも指定しなければなりません(たとえば、VIEWレコードなど)。TPTYPE-REC内のLENによって、送信時には送信するバイト数を示し、受信時にはユーザーのレコードに移動するバイト数を示します。サポートされるREC-TYPEは次のとおりです。

CARRAY

STRING

VIEW

上記のレコード・タイプの中の2つには、同等のタイプがあります。X_OCTETはCARRAYと同じであり、X_COMMONはVIEWと同じです。X_COMMONは、VIEWがサポートするデータ・タイプのサブセットをサポートします。それらは、longs (PIC S9(9) COMP-5)、shorts (PIC S9(4) COMP-5)、およびcharacters (PIC X(n))です。X_COMMONは、CとCOBOLの両方のプログラムがやりとりする際に、使用してください。

どのタイプの場合でも、正常に転送が行われると、LENには転送されたバイト数が入ります。受信時には、LENには、データ領域に入る最大バイト数が入っていなければなりません。正常な呼出しの後、LENは、データ領域に移動されたバイト数が入ります。着信メッセージのサイズがLENで指定されているサイズより大きいと、LENで指定されたデータ長分のみがデータ領域に移動され、残りのデータは破棄されます。

バッファ・タイプ・スイッチ

Oracle Tuxedoシステムでは、ユーザー固有のレコード・タイプを追加できます。詳細は、『Oracle Tuxedo ATMI C関数リファレンス』の「C言語アプリケーション・トランザクション・モニター・インタフェースについて」のバッファ・タイプ・スイッチに関する項を参照してください。

プロセスごとのシングル・コンテキストとマルチコンテキスト

Oracle Tuxedoシステムでは、クライアント・プログラムはプロセスごとに1つまたは複数のアプリケーションとの関連を作成することができます。TPINFDEF-RECのCONTEXTS-FLAGにTP-MULTI-CONTEXTSを設定してTPINITIALIZE()が呼び出されると、複数のクライアント・コンテキストを利用できます。TPINITIALIZE()が暗黙的に呼び出された場合、またはCONTEXTS-FLAGにTP-MULTI-CONTEXTSが設定されていない場合は、1つのアプリケーションとの関連しか作成できません。

シングル・コンテキスト・モードでTPINITIALIZE()が2回以上呼び出された場合(つまり、クライアントがアプリケーションに参加した後で呼び出された場合)は、アクションは何も実行されず、成功を示す戻り値が返されます。

マルチコンテキスト・モードでは、TPINITIALIZE()の呼出しのたびに新しいアプリケーションとの関連が作成されます。プログラムはTPGETCTXT()を呼び出すことによりこのアプリケーション関連を表すハンドルを取得し、TPSETCTXT()を呼び出してそのコンテキストを設定することができます。

アプリケーションでシングル・コンテキスト・モードが選択されると、すべてのアプリケーション関連が終了するまで、すべてのTPINITIALIZE()呼出しでシングル・コンテキスト・モードを指定する必要があります。同様に、アプリケーションでマルチコンテキスト・モードが選択されると、すべてのアプリケーション関連が終了するまで、すべてのTPINITIALIZE()呼出しでマルチコンテキスト・モードを指定する必要があります。

サーバー・プログラムは1つのアプリケーションとしか関連付けられないため、クライアントとして機能することはありません。

表2は、クライアント・プロセス内で発生する、非初期化状態、シングル・コンテキスト・モードで初期化された状態、およびマルチコンテキスト・モードで初期化された状態の遷移を示しています。

非請求通知

上記のように定義されたクライアント/サーバー間でのやりとりの境界外からメッセージをアプリケーション・クライアントに送る方法は2通りあります。第1の方法は、TPBROADCAST()によって実現されるブロードキャスト機構です。この関数により、アプリケーション・クライアント、サーバーおよび管理者は割り当てられた名前に基づいて選択されるクライアントに型付きレコード・メッセージをブロードキャストすることができます。クライアントに割り当てられる名前は、一部はアプリケーションにより(特に、TPINFDEF-RECデータ構造体にTPINITIALIZE実行時に渡される情報により)、また一部は(クライアントがアプリケーションのアクセスに使用するプロセッサに基づいて)システムにより決められます。

もう1つの方法は、以前のあるいは現在のサービス・リクエストから識別される特定クライアントによる通知方法です。各サービス・リクエストには、そのサービス・リクエストを出したクライアントを特定するユニークなクライアント識別子が含まれています。サービス・ルーチンの中から出されるTPCALL()およびTPFORWAR()関数の呼出しは、そのサービス・リクエストの連鎖に対応する元のクライアントを変更しません。クライアント識別子は保存しておき、アプリケーション・サーバー間で受け渡すことができます。この方法で識別されたクライアントに対する通知は、TPNOTIFY()関数を使用して行います。

COBOL言語ATMIの戻り値とその他の定義

ATMIルーチンは、次に挙げる戻り値と設定の定義を使用します。

*
* TPSTATUS.cbl
*
05 TP-STATUS       PIC S9(9) COMP-5.
  88 TPOK            VALUE 0.
  88 TPEABORT        VALUE 1.
  88 TPEBADDESC      VALUE 2.
  88 TPEBLOCK        VALUE 3.
  88 TPEINVAL        VALUE 4.
  88 TPELIMIT        VALUE 5.
  88 TPENOENT        VALUE 6.
  88 TPEOS           VALUE 7.
  88 TPEPERM         VALUE 8.
  88 TPEPROTO        VALUE 9.
  88 TPESVCERR       VALUE 10.
  88 TPESVCFAIL      VALUE 11.
  88 TPESYSTEM       VALUE 12.
  88 TPETIME         VALUE 13.
  88 TPETRAN         VALUE 14.
  88 TPEGOTSIG       VALUE 15.
  88 TPERMERR        VALUE 16.
  88 TPEITYPE        VALUE 17.
  88 TPEOTYPE        VALUE 18.
  88 TPERELEASE      VALUE 19.
  88 TPEHAZARD       VALUE 20.
  88 TPEHEURISTIC    VALUE 21.
  88 TPEEVENT        VALUE 22.
  88 TPEMATCH        VALUE 23.
  88 TPEDIAGNOSTIC   VALUE 24.
  88 TPEMIB          VALUE 25.
  88 TPEMAXVAL       VALUE 26.
05 TPEVENT         PIC S9(9) COMP-5.
  88 TPEV-NOEVENT    VALUE 0.
  88 TPEV-DISCONIMM  VALUE 1.
  88 TPEV-SENDONLY   VALUE 2.
  88 TPEV-SVCERR     VALUE 3.
  88 TPEV-SVCFAIL    VALUE 4.
  88 TPEV-SVCSUCC    VALUE 5.
05 TPSVCTIMOUT     PIC S9(9) COMP-5.
  88 TPED-NOEVENT    VALUE 0.
  88 TPEV-SVCTIMEOUT VALUE 1.
  88 TPEV-TERM       VALUE 2.
05 APPL-RETURN-CODE PIC S9(9) COMP-5.

TPTYPE COBOL構造体は、アプリケーション・データの送受信時に必ず使用されます。REC-TYPEは、送信されるデータ・レコードのタイプを表します。SUB-TYPEは、VIEW REC-TYPEが指定されている場合のVIEWの名前を表します。LENは、送信するデータのサイズおよび受信されるデータのサイズを表します。

*
* TPTYPE.cbl
*
05 REC-TYPE      PIC X(8).
  88 X-OCTET       VALUE "X_OCTET".
  88 X-COMMON      VALUE "X_COMMON".
05 SUB-TYPE      PIC X(16).
05 LEN           PIC S9(9) COMP-5.
  88 NO-LENGTH     VALUE 0.
05 TPTYPE-STATUS PIC S9(9) COMP-5.
  88 TPTYPEOK      VALUE 0.
  88 TPTRUNCATE    VALUE 1.

TPSVCDEFデータ構造体は、Oracle Tuxedoシステムと設定値をやりとりする関数によって使用されます。

*
* TPSVCDEF.cbl 
*
05 COMM-HANDLE         PIC S9(9) COMP-5.
05 TPBLOCK-FLAG        PIC S9(9) COMP-5.
  88 TPBLOCK             VALUE 0.
  88 TPNOBLOCK           VALUE 1.
05 TPTRAN-FLAG         PIC S9(9) COMP-5.
  88 TPTRAN              VALUE 0.
  88 TPNOTRAN            VALUE 1.
05 TPREPLY-FLAG        PIC S9(9) COMP-5.
  88 TPREPLY             VALUE 0.
  88 TPNOREPLY           VALUE 1.
05 TPACK-FLAG          PIC S9(9) COMP-5 REDEFINES TPREPLY-FLAG.
  88 TPNOACK             VALUE 0.
  88 TPACK               VALUE 1.
05 TPTIME-FLAG         PIC S9(9) COMP-5.
  88 TPTIME              VALUE 0.
  88 TPNOTIME            VALUE 1.
05 TPSIGRSTRT-FLAG     PIC S9(9) COMP-5.
  88 TPNOSIGRSTRT        VALUE 0.
  88 TPSIGRSTRT          VALUE 1.
05 TPGETANY-FLAG       PIC S9(9) COMP-5.
  88 TPGETHANDLE         VALUE 0.
  88 TPGETANY            VALUE 1.
05 TPSENDRECV-FLAG     PIC S9(9) COMP-5.
  88 TPSENDONLY          VALUE 0.
  88 TPRECVONLY          VALUE 1.
05 TPNOCHANGE-FLAG     PIC S9(9) COMP-5.
  88 TPCHANGE            VALUE 0.
  88 TPNOCHANGE          VALUE 1.
05 TPSERVICETYPE-FLAG  PIC S9(9) COMP-5.
  88 TPREQRSP            VALUE IS 0.
  88 TPCONV              VALUE IS 1.
*
05 APPKEY              PIC S9(9) COMP-5.
05 CLIENTID OCCURS 4 TIMES PIC S9(9) COMP-5.
05 SERVICE-NAME        PIC X(127).

TPINFDEFデータ構造体は、TPINITIALIZE()によってアプリケーションに結合する際に使用されます。

*
* TPINFDEF.cbl
*
05 USRNAME            PIC X(30).
05 CLTNAME            PIC X(30).
05 PASSWD             PIC X(30).
05 GRPNAME            PIC X(30).
05 NOTIFICATION-FLAG  PIC S9(9) COMP-5.
  88 TPU-SIG           VALUE 1.
  88 TPU-DIP           VALUE 2.
  88 TPU-IGN           VALUE 3.
05 ACCESS-FLAG        PIC S9(9) COMP-5.
  88 TPSA-FASTPATH     VALUE 1.
  88 TPSA-PROTECTED    VALUE 2.
05 CONTEXTS-FLAG      PIC S9(9) COMP-5.
  88 TP-SINGLE-CONTEXT VALUE 0.
  88 TP-MULTI-CONTEXTS VALUE 1.
05 DATALEN            PIC S9(9) COMP-5.

TPCONTEXTDEFデータ構造体は、TPGETCTXT()およびTPSETCTXT()がプログラムのコンテキストを操作する際に使用されます。

      *

      *  TPCONTEXTDEF.cbl

      *

       05 CONTEXT     PIC S9(9) COMP-5.

TPQUEDEFデータ構造体は、キューへのメッセージ登録に関連する情報を渡したり、取り出したりする際に、使用します。

*
* TPQUEDEF.cbl
*
05 TPBLOCK-FLAG                  PIC S9(9) COMP-5.
  88 TPNOBLOCK                     VALUE 0.
  88 TPBLOCK                       VALUE 1.
05 TPTRAN-FLAG                   PIC S9(9) COMP-5.
  88 TPNOTRAN                      VALUE 0.
  88 TPTRAN                        VALUE 1.
05 TPTIME-FLAG                   PIC S9(9) COMP-5.
  88 TPNOTIME                      VALUE 0.
  88 TPTIME                        VALUE 1.
05 TPSIGRSTRT-FLAG               PIC S9(9) COMP-5.
  88 TPNOSIGRSTRT                  VALUE 0.
  88 TPSIGRSTRT                    VALUE 1.
05 TPNOCHANGE-FLAG               PIC S9(9) COMP-5.
  88 TPNOCHANGE                    VALUE 0.
  88 TPCHANGE                      VALUE 1.
05 TPQUE-ORDER-FLAG              PIC S9(9) COMP-5.
  88 TPQDEFAULT                    VALUE 0.
  88 TPQTOP                        VALUE 1.
  88 TPQBEFOREMSGID                VALUE 2.
05 TPQUE-TIME-FLAG               PIC S9(9) COMP-5.
  88 TPQNOTIME                     VALUE 0.
  88 TPQTIME-ABS                   VALUE 1.
  88 TPQTIME-REL                   VALUE 2.
05 TPQUE-PRIORITY-FLAG           PIC S9(9) COMP-5.
  88 TPQNOPRIORITY                 VALUE 0.
  88 TPQPRIORITY                   VALUE 1.
05 TPQUE-CORRID-FLAG             PIC S9(9) COMP-5.
  88 TPQNOCORRID                   VALUE 0.
  88 TPQCORRID                     VALUE 1.
05 TPQUE-REPLYQ-FLAG             PIC S9(9) COMP-5.
  88 TPQNOREPLYQ                   VALUE 0.
  88 TPQREPLYQ                     VALUE 1.
05 TPQUE-FAILQ-FLAG              PIC S9(9) COMP-5.
  88 TPQNOFAILUREQ                 VALUE 0.
  88 TPQFAILUREQ                   VALUE 1.
05 TPQUE-MSGID-FLAG              PIC S9(9) COMP-5.
  88 TPQNOMSGID                    VALUE 0.
  88 TPQMSGID                      VALUE 1.
05 TPQUE-GETBY-FLAG              PIC S9(9) COMP-5.
  88 TPQGETNEXT                    VALUE 0.
  88 TPQGETBYMSGIDOLD              VALUE 1.
  88 TPQGETBYCORRIDOLD             VALUE 2.
  88 TPQGETBYMSGID                 VALUE 3.
  88 TPQGETBYCORRID                VALUE 4.
05 TPQUE-WAIT-FLAG               PIC S9(9) COMP-5.
  88 TPQNOWAIT                     VALUE 0.
  88 TPQWAIT                       VALUE 1.
05 TPQUE-DELIVERY-FLAG           PIC S9(9) COMP-5.
  88 TPQNODELIVERYQOS              VALUE 0.
  88 TPQDELIVERYQOS                VALUE 1.
05 TPQUEQOS-DELIVERY-FLAG        PIC S9(9) COMP-5.
  88 TPQQOSDELIVERYDEFAULTPERSIST  VALUE 0.
  88 TPQQOSDELIVERYPERSISTENT      VALUE 1. 
  88 TPQQOSDELIVERYNONPERSISTENT   VALUE 2.
05 TPQUE-REPLY-FLAG              PIC S9(9) COMP-5.
  88 TPQNOREPLYQOS                 VALUE 0.
  88 TPQREPLYQOS                   VALUE 1.
05 TPQUEQOS-REPLY-FLAG           PIC S9(9) COMP-5.
  88 TPQQOSREPLYDEFAULTPERSIST     VALUE 0.
  88 TPQQOSREPLYPERSISTENT         VALUE 1. 
  88 TPQQOSREPLYNONPERSISTENT      VALUE 2.
05 TPQUE-EXPTIME-FLAG            PIC S9(9) COMP-5.
  88 TPQNOEXPTIME                  VALUE 0.
  88 TPQEXPTIME-ABS                VALUE 1. 
  88 TPQEXPTIME-REL                VALUE 2.
  88 TPQEXPTIME-NONE               VALUE 3.
05 TPQUE-PEEK-FLAG               PIC S9(9) COMP-5.
  88 TPQNOPEEK                     VALUE 0.
  88 TPQPEEK                       VALUE 1.
05 DIAGNOSTIC                    PIC S9(9) COMP-5.
  88 QMEINVAL                      VALUE -1.
  88 QMEBADRMID                    VALUE -2.
  88 QMENOTOPEN                    VALUE -3.
  88 QMETRAN                       VALUE -4.
  88 QMEBADMSGID                   VALUE -5.
  88 QMESYSTEM                     VALUE -6.
  88 QMEOS                         VALUE -7.
  88 QMEABORTED                    VALUE -8.
  88 QMEPROTO                      VALUE -9.
  88 QMEBADQUEUE                   VALUE -10.
  88 QMENOMSG                      VALUE -11.
  88 QMEINUSE                      VALUE -12.
  88 QMENOSPACE                    VALUE -13.
  88 QMERELEASE                    VALUE -14.
  88 QMEINVHANDLE                  VALUE -15.
  88 QMESHARE                      VALUE -16.
05 DEQ-TIME                      PIC S9(9) COMP-5.
05 EXP-TIME                      PIC S9(9) COMP-5.
05 PRIORITY                      PIC S9(9) COMP-5.
05 MSGID                         PIC X(32).
05 CORRID                        PIC X(32).
05 QNAME                         PIC X(127).
05 QSPACE-NAME                   PIC X(127).
05 REPLYQUEUE                    PIC X(127).
05 FAILUREQUEUE                  PIC X(127).
05 CLIENTID OCCURS4 TIMES        PIC S9(9) COMP-5.
05 APPL-RETURN-CODE              PIC S9(9) COMP-5.
05 APPKEY                        PIC S9(9) COMP-5.

TPSVCRETデータ構造体は、TPRETURN()がトランザクションのステータスを表す際に、使用されます。

*
* TPSVCRET.cbl
*
05 TP-RETURN-VAL                 PIC S9(9) COMP-5.
  88 TPSUCCESS                     VALUE 0.
  88 TPFAIL                        VALUE 1.
  88 TPEXIT                        VALUE 2.
05 APPL-CODE                     PIC S9(9) COMP-5.

TPTRXDEFデータ構造体はトランザクション・タイムアウトを設定するためにTPBEGIN()、トランザクション識別子を獲得するためにTPSUSPEND()、設定するためにTPRESUME()でそれぞれ使用されます。

*
* TPTRXDEF.cbl
*
05 T-OUT                        PIC S9(9) COMP-5 VALUE IS 0.
05 TRANID       OCCURS 6 TIMES   PIC S9(9) COMP-5.

TPCMTDEFデータ構造体は、TPSCMT()がコミット・レベル特性を設定する際に、使用されます。

*
* TPCMTDEF.cbl
*
05 CMT-FLAG                      PIC S9(9) COMP-5.
  88 TP-CMT-LOGGED                 VALUE 1.
  88 TP-CMT-COMPLETE               VALUE 2.
05 PREV-CMT-FLAG                 PIC S9(9) COMP-5.
  88 PREV-TP-CMT-LOGGED            VALUE 1.
  88 PREV-TP-CMT-COMPLETE          VALUE 2.

TPAUTDEFデータ構造体は、TPCHKAUTH()が認証の必要性を調べる際に、使用されます。

* TPAUTDEF.cbl
*
05 AUTH-FLAG                     PIC S9(9) COMP-5.
  88 TPNOAUTH                      VALUE 0.
  88 TPSYSAUTH                     VALUE 1.
  88 TPAPPAUTH                     VALUE 2.

TPPRIDEFデータ構造体は、TPSPRIO()およびTPGPRIO()がメッセージの優先度を操作する際に、使用されます。

*
* TPPRIDEF.cbl
*
05 PRIORITY                      PIC S9(9) COMP-5.
05 PRIO-FLAG                     PIC S9(9) COMP-5.
  88 TPABSOLUTE                    VALUE 0.
  88 TPRELATIVE                    VALUE 1.

TPTRXLEVデータ構造体は、TPGETLEV()がトランザクション・レベル設定を取り出す際に使用されます。

*
* TPTRXLEV.cbl
*
05 TPTRXLEV-FLAG     PIC S9(9) COMP-5.
  88 TP-NOT-IN-TRAN    VALUE 0.
  88 TP-IN-TRAN        VALUE 1.

TPBCTDEFデータ構造体は、TPNOTIFY()およびTPBROADCAST()が通知を送る際に、使用されます。

*
* TPBCTDEF.cbl
*
05 TPBLOCK-FLAG      PIC S9(9) COMP-5.
  88 TPBLOCK           VALUE 0.
  88 TPNOBLOCK         VALUE 1.
05 TPTIME-FLAG       PIC S9(9) COMP-5.
  88 TPTIME            VALUE 0.
  88 TPNOTIME          VALUE 1.
05 TPSIGRSTRT-FLAG   PIC S9(9) COMP-5.
  88 TPNOSIGRSTRT      VALUE 0.
  88 TPSIGRSTRT        VALUE 1.
05 LMID              PIC X(30).
05 USERNAME          PIC X(30).
05 CLTNAME           PIC X(30).

FML-INFOデータ構造体は、FINIT()、FVSTOF()、およびFVFTOS()がFMLバッファを扱う際に、使用されます。

*
* FMLINFO.cbl
*
05 FML-STATUS        PIC S9(9) COMP-5.
  88 FOK               VALUE 0.
  88 FALIGNERR         VALUE 1.
  88 FNOTFLD           VALUE 2.
  88 FNOSPACE          VALUE 3.
  88 FNOTPRES          VALUE 4.
  88 FBADFLD           VALUE 5.
  88 FTYPERR           VALUE 6.
  88 FEUNIX            VALUE 7.
  88 FBADNAME          VALUE 8.
  88 FMALLOC           VALUE 9.
  88 FSYNTAX           VALUE 10.
  88 FFTOPEN           VALUE 11.
  88 FFTSYNTAX         VALUE 12.
  88 FEINVAL           VALUE 13.
  88 FBADTBL           VALUE 14.
  88 FBADVIEW          VALUE 15.
  88 FVFSYNTAX         VALUE 16.
  88 FVFOPEN           VALUE 17.
  88 FBADACM           VALUE 18.
  88 FNOCNAME          VALUE 19.
  88 FEBADOP           VALUE 20.
*
05 FML-LENGTH        PIC S9(9) COMP-5.
*
05 FML-MODE          PIC S9(9) COMP-5.
  88 FUPDATE           VALUE 1.
  88 FCONCAT           VALUE 2.
  88 FJOIN             VALUE 3.
  88 FOJOIN            VALUE 4.
*
05 VIEWNAME          PIC X(33).

TPEVTDEFデータ構造体は、イベントの通知とサブスクリプションを処理するためにTPPOST()、TPSUBSCRIBE()、およびTPUNSUBSCRIBE()が使用します。

*
* TPEVTDEF.cbl
*
05 TPBLOCK-FLAG        PIC S9(9) COMP-5.
  88 TPBLOCK             VALUE 0.
  88 TPNOBLOCK           VALUE 1.
05 TPTRAN-FLAG         PIC S9(9) COMP-5.
  88 TPTRAN              VALUE 0.
  88 TPNOTRAN            VALUE 1.
05 TPREPLY-FLAG        PIC S9(9) COMP-5.
  88 TPREPLY             VALUE 0.
  88 TPNOREPLY           VALUE 1.
05 TPTIME-FLAG         PIC S9(9) COMP-5.
  88 TPTIME              VALUE 0.
  88 TPNOTIME            VALUE 1.
05 TPSIGRSTRT-FLAG     PIC S9(9) COMP-5.
  88 TPNOSIGRSTRT        VALUE 0.
  88 TPSIGRSTRT          VALUE 1.
05 TPEV-METHOD-FLAG    PIC S9(9) COMP-5.
  88 TPEVNOTIFY          VALUE 0.
  88 TPEVSERVICE         VALUE 1.
  88 TPEVQUEUE           VALUE 2.
05 TPEV-PERSIST-FLAG   PIC S9(9) COMP-5.
  88 TPEVNOPERSIST       VALUE 0.
  88 TPEVPERSIST         VALUE 1.
05 TPEV-TRAN-FLAG      PIC S9(9) COMP-5.
  88 TPEVNOTRAN          VALUE 0.
  88 TPEVTRAN            VALUE 1.
*
05 EVENT-COUNT         PIC S9(9) COMP-5.
05 SUBSCRIPTION-HANDLE PIC S9(9) COMP-5.
05 NAME-1              PIC X(127).
05 NAME-2              PIC X(127).
05 EVENT-NAME          PIC X(31).
05 EVENT-EXPR          PIC X(255).
05 EVENT-FILTER        PIC X(255).

TPKEYDEFデータ構造体は、メッセージ・ベースのデジタル署名と暗号化を行うために使用する公開鍵と秘密鍵を管理する場合に、TPKEYCLOSE()、TPKEYGETINFO()、TPKEYOPEN()、およびTPKEYSETINFO()によって使用されます。

*
*      TPKEYDEF.cbl
*
	05     KEY-HANDLE           PIC S9(9) COMP-5.
	05     PRINCIPAL-NAME       PIC X(512).
	05     LOCATION             PIC X(1024).
	05     IDENTITY-PROOF       PIC X(2048).
	05     PROOF-LEN            PIC S9(9) COMP-5.
	05     CRYPTO-PROVIDER      PIC X(128).
	05     SIGNATURE-FLAG       PIC S9(9) COMP-5.
	       88 TPKEY-NOSIGNATURE   VALUE 0.
	       88 TPKEY-SIGNATURE     VALUE 1.
	05     DECRYPT-FLAG         PIC S9(9) COMP-5.
	       88 TPKEY-NODECRYPT     VALUE 0.
	       88 TPKEY-DECRYPT       VALUE 1.
	05     ENCRYPT-FLAG         PIC S9(9) COMP-5.
	       88 TPKEY-NOENCRYPT     VALUE 0.
	       88 TPKEY-ENCRYPT       VALUE 1.
	05     AUTOSIGN-FLAG        PIC S9(9) COMP-5.
	       88 TPKEY-NOAUTOSIGN    VALUE 0.
	       88 TPKEY-AUTOSIGN      VALUE 1.
	05     AUTOENCRYPT-FLAG     PIC S9(9) COMP-5.
	       88 TPKEY-NOAUTOENCRYPT VALUE 0.
	       88 TPKEY-AUTOENCRYPT   VALUE 1.
	05     ATTRIBUTE-NAME       PIC X(64).
	05     ATTRIBUTE-VALUE-LEN  PIC S9(9) COMP-5.

COBOL言語TXの戻り値その他の定義

TXルーチンは、次に挙げる戻り値と設定の定義を使用します。

*
* TXSTATUS.cbl
*
05 TX-STATUS      PIC S9(9) COMP-5.
  88 TX-NOT-SUPPORTED      VALUE 1.
*  Normal execution
  88 TX-OK                 VALUE 0.
*  Normal execution
  88 TX-OUTSIDE            VALUE -1.
*  Application is in an RM local transaction
  88 TX-ROLLBACK           VALUE -2.
*  Transaction was rolled back
  88 TX-MIXED              VALUE -3.
*  Transaction was partially committed and partially
*  rolled back
  88 TX-HAZARD             VALUE -4.
*  Transaction may have been partially committed and
*  partially rolled back
  88 TX-PROTOCOL-ERROR     VALUE -5.
*  Routine invoked in an improper context
  88 TX-ERROR              VALUE -6.
*  Transient error
  88 TX-FAIL               VALUE -7.
*  Fatal error
  88 TX-EINVAL             VALUE -8.
*  Invalid arguments were given
  88 TX-COMMITTED          VALUE -9.
*  The transaction was heuristically committed
  88 TX-NO-BEGIN           VALUE -100.
*  Transaction committed plus new transaction could not
*  be started
  88 TX-ROLLBACK-NO-BEGIN  VALUE -102.
*  Transaction rollback plus new transaction could not
*  be started
  88 TX-MIXED-NO-BEGIN     VALUE -103.
*  Mixed plus new transaction could not be started
  88 TX-HAZARD-NO-BEGIN    VALUE -104.
*  Hazard plus new transaction could not be started
  88 TX-COMMITTED-NO-BEGIN VALUE -109.
*  Heuristically committed plus transaction could not
*  be started

TXINFDEFレコードは、TXINFORM()コールの結果が格納されるデータ構造体を定義します。

*
* TXINFDEF.cbl
*
05 XID-REC.
*  XID record
10 FORMAT-ID            PIC S9(9) COMP-5.
*  A value of -1 in FORMAT-ID means that the XID is NULL
10 GTRID-LENGTH         PIC S9(9) COMP-5.
10 BRANCH-LENGTH        PIC S9(9) COMP-5.
10 XID-DATA             PIC X(128).
05 TRANSACTION-MODE     PIC S9(9) COMP-5.
*  Transaction mode settings
  88 TX-NOT-IN-TRAN            VALUE 0.
  88 TX-IN-TRAN                VALUE 1.
05 COMMIT-RETURN        PIC S9(9) COMP-5.
*  Commit_return settings
  88 TX-COMMIT-COMPLETED       VALUE 0.
  88 TX-COMMIT-DECISION-LOGGED VALUE 1.
05 TRANSACTION-CONTROL  PIC S9(9) COMP-5.
*  Transaction_control settings
  88 TX-UNCHAINED              VALUE 0.
  88 TX-CHAINED                VALUE 1.
05 TRANSACTION-TIMEOUT  PIC S9(9) COMP-5.
*  Transaction_timeout value
  88 NO-TIMEOUT                VALUE 0.
05 TRANSACTION-STATE    PIC S9(9) COMP-5.
*  Transaction_state information
  88 TX-ACTIVE                 VALUE 0.
  88 TX-TIMEOUT-ROLLBACK-ONLY  VALUE 1.
  88 TX-ROLLBACK-ONLY          VALUE 2.

ATMIの状態遷移

Oracle Tuxedoシステムは、各プログラムの状態を記録し、各種の関数呼び出しやオプションごとに正当な状態遷移が行われているかどうかを検証します。この状態情報には、プログラムのタイプ(リクエスト/レスポンス型サーバー、会話サーバー、またはクライアント)、初期化状態(初期化済み、非初期化)、リソースの管理状態(クローズまたはオープン)、プログラムのトランザクション状態およびすべての非同期リクエスト/レスポンスおよび接続ハンドルの状態などがあります。不当な状態遷移が行われようとすると、呼び出された関数は異常終了し、TPSTATUS-RECにTPEPROTO()が設定されます。この情報に関する正規の状態と遷移について、次の表に示します。

表3は、リクエスト/レスポンス型サーバー、会話型サーバーおよびクライアントがどの関数を呼び出すことができるかを示しています。ただし、TPSVRINIT()とTPSVRDONE()はこの表には示してありません。これらの関数はアプリケーションからは呼び出されないためです。これらはアプリケーションが提供する関数ですが、Oracle Tuxedoシステムによって呼び出されます。

以下に示す表は、特に明記されていないかぎり、クライアントとサーバー両方に適用されます。なお、関数によってはクライアントとサーバーの両方が呼び出せるわけではないので(たとえばTPINITIALIZE())、以下の状態遷移のなかには、両方のプログラム・タイプには適用できないものもあります。上記の表を参照して、目的のプログラムから特定の関数を呼び出すことができるかどうかを判断するようにしてください。

表 4は、クライアント・プログラムがトランザクション・マネージャで初期化され登録されているかどうかを示しています。この表では、TPINITIALIZE()を使用しているものとします。TPINITIALIZE()は、シングル・コンテキスト・モードでは任意選択可能です。つまり、シングル・コンテキストのクライアントは、多数のATMI関数のどれか(たとえば、TPACALL()またはTPCALL())を発行することによって、暗黙的にアプリケーションに参加することができます。次のいずれかに該当する場合、クライアントはTPINITIALIZE()を使用する必要があります。

サーバーはTPSVRINIT()関数が呼び出される前にOracle Tuxedoディスパッチャによって初期化状態になり、TPSVRDONE()関数が返された後、Oracle Tuxedoディスパッチャによって非初期化状態になります。なお、下記のすべての表において、関数がエラーを起こした場合、特に明記されていないかぎり、プログラムの状態は変わりません。

表4は、初期化状態を示しています。

以降の表は、(TPINITIALIZE()、TPSETCTXT()、またはOracle Tuxedoのサービス・ディスパッチャを介してこの状態でプログラムが到着したかどうかに関わりなく)事前条件として状態がI1であると想定しています。

表5は、クライアントまたはサーバーに対応するリソース・マネージャが初期化されているかいないかに応じてクライアントまたはサーバーの状態を示しています。

表6は、プログラムがトランザクションに対応しているかどうかに関してそのプログラムの状態を示したものです。サーバーの場合、状態T₁とT₂への遷移は、事前条件として状態R₁を想定しています(たとえば、TPOPEN()はそれ以降TPCLOSE()またはTPTERM()への呼出しがないものとして呼び出されています)。

表7は、TPACALL()が戻す1つのリクエスト・ハンドルの状態を示すものです。

表8は、TPCONNECT()によって戻される接続記述子またはTPSVCINFO構造体でサービス呼出しを行うことによって提供される接続記述子の状態を示したものです。接続記述子をとらないプリミティブの場合、特に明記されていないかぎり、状態の変化はすべての接続記述子に適用されます。

状態には次のものがあります。

C₀ - ハンドルなし
C₁ - TPCONNECTハンドル送信専用
C₂ - TPCONNECTハンドル受信専用
C₃ - TPSVCDEFハンドル送信専用
C₄ - TPSVCDEFハンドル受信専用

TXの状態遷移

Oracle Tuxedoでは、プロセスが必ずTX関数を正しい順序で呼び出すことを確認します。不正の状態遷移が試行される(つまり、ブランクの遷移エントリの状態から呼出しを行う)と、呼び出された関数は、TX_PROTOCOL_ERRORを返します。TX関数の正当な状態および遷移を、次の表に示します。異常終了を返す呼出しの場合、この表で特に明記されていないかぎり、状態遷移は行われません。Oracle Tuxedoのクライアントまたはサーバーは、TX関数を使用できます。

状態は、次のように定義されています。

S₀

S₁

S₂

S₃

S₄

関連項目

buffer(3c)、TPINITIALIZE(3cbl)、TPADVERTISE(3cbl)、TPBEGIN(3cbl), TPCALL(3cbl)、TPCONNECT(3cbl)、TPGETCTXT(3cbl)、TPKEYCLOSE(3cbl)、TPKEYGETINFO(3cbl)、TPKEYOPEN(3cbl)、TPKEYSETINFO(3cbl)、TPOPEN(3cbl)、TPSETCTXT(3cbl)、TPSVCSTART(3cbl)、tuxtypes(5)、typesw(5)

FINIT、FINIT32(3cbl)

名前

FINIT()、FINIT32() - フィールド化バッファの初期化

形式

01 FML-BUFFER.
05 FML-ALIGN PIC S9(9) USAGE IS COMP.
05 FML-DATA PIC X(applen).

01 FML-REC
COPY FMLINFO.

CALL "FINIT" USING FML-BUFFER FML-REC.

CALL "FINIT32" USING FML-BUFFER FML-REC.

説明

FINIT()は、フィールド化バッファの初期化をする場合に呼び出すことができます。FML-BUFFERは、フィールド化バッファで使用されるレコードです。FML16とFML32の両方で使用するためには、4バイト境界にアラインする必要があります。これを実現するには、上記の「形式」に示すように2つのレコード要素を定義します。FML-REC中のFML-LENGTHはレコードの長さです。フィールド化バッファに対応して、内部構造体がフィールドなしで設定されます。アプリケーション・プログラムはレコードをFINIT()、FVFTOS()、またはFVSTOF()に渡したり、型付きレコードが必要なATMI呼出しに渡す(この場合、タイプは「FML」でサブタイプはありません)場合を除いて、レコードを解釈してはなりません。

FINIT32()は32ビットFMLで使用します。

戻り値

FINIT()は正常終了時には、FML-REC内のFML-STATUSにFOKを設定します。

エラーが発生した場合は、FML-STATUSは0以外の値に設定されます。

エラー

次の条件が発生すると、FINIT()は異常終了し、FML-REC内のFML-STATUSに次の値を設定します。

[FALIGNERR]

[FNOSPACE]

例

バッファからフィールドを削除する再初期化のための正しい方法を以下に示します。Finit(frfr, (FLDLEN)Fsizeof(fbfr));

関連項目

『Oracle Tuxedo ATMI FML関数リファレンス』の「FML関数の紹介」

FVFTOS、FVFTOS32(3cbl)

名前

FVFTOS()、FVFTOS32() - フィールド化バッファからCOBOL構造体にコピーする

形式

01 DATA-REC. 
COPY User data. 
 
01 FML-BUFFER.
 05 FML-ALIGN      PIC S9(9) USAGE IS COMP.
 05 FML-DATA       PIC X(applen).
 
01 FML-REC COPY FMLINFO. 
 
CALL "FVFTOS" USING FML-BUFFER DATA-REC FML-REC. 
 
CALL "FVFTOS32" USING FML-BUFFER DATA-REC FML-REC.

説明

FVFTOS()関数はフィールド化バッファからCOBOLのレコードにデータを転送します。FML-BUFFERは、FINIT()で初期化されたフィールド化バッファを指すポインタです。DATA-RECは、Cの構造体へのポインタです。FML-REC中のVIEWNAMEは、COBOLのレコードを記述するVIEWの名前です。

各フィールドは、フィールド化バッファから、VIEWNAMEでの要素の記述に基づいた構造体にコピーされます。フィールド化バッファのフィールドに対応する要素がCOBOLのレコードに存在しない場合は、そのフィールドは無視されます。COBOLのレコードで指定された要素に対応するフィールドがフィールド化バッファに存在しない場合は、その要素にはNULL値がコピーされます。使用するNULLの値は、各要素ごとにVIEW記述で定義できます。

複数のオカレンスをCOBOLのレコードに格納するには、レコードの要素をOCCURSで定義してください。バッファ中のフィールドのオカレンスが、要素のオカレンスよりも少ない場合は、余分な要素スロットにはNULL値が代入されます。反対に、バッファ中のフィールドのオカレンスが、要素のオカレンスよりも多い場合は、余分なオカレンスは無視されます。

FVFTOS32()は、より多くのフィールドを持つ大きなview用のview32()型付きバッファで定義されたviewのために使用されます。

戻り値

FVFTOS32()は正常終了時には、FML-REC内のFML-STATUSにFOKを設定します。

エラーが発生した場合は、FML-STATUSは0以外の値に設定されます。

エラー

次の条件が発生すると、FVFTOS()は異常終了し、FML-STATUSに次の値を設定します。

[FALIGNERR]

[FNOTFLD]

[FEINVAL]

[FBADACM]

[FBADVIEW]

関連項目

『Oracle Tuxedo ATMI FML関数リファレンス』の「FML関数の紹介」、viewfile(5)

FVSTOF(3cbl)

名前

FVSTOF() - C構造体からフィールド化バッファにコピーする

形式

01 DATA-REC.
 COPY User data. 
 
01 FML-BUFFER.
 05 FML-ALIGN      PIC S9(9) USAGE IS COMP.
 05 FML-DATA       PIC X(applen).
 
01 FML-REC
 COPY FMLINFO. 
 
CALL "FVSTOF" USING FML-BUFFER DATA-REC FML-REC. 
 
CALL "FVSTOF32" USING FML-BUFFER DATA-REC FML-REC.

説明

FVSTOF()は、C構造体からフィールド化バッファにデータを転送します。FML-BUFFERは、フィールド化バッファを含むレコードです。DATA-RECは、COBOLのレコードです。FML-REC中のVIEWNAMEは、COBOLのレコードを記述するVIEWの名前です。FML-REC中のFML-MODEには、データを転送する方式を指定します。FML-MODEには次の4種類の値のいずれかを設定できます。

FUPDATE
FOJOIN
FJOIN
FCONCAT

これらのモードの動作は、Fupdate、Fupdate32(3fml)、Fojoin、Fojoin32(3fml)、Fjoin、Fjoin32(3fml)、およびFconcat、Fconcat32(3fml)で説明したものと同じです。これらの関数ではソース・バッファを指定するのに対して、FVSTOF()ではCOBOLのレコードを指定することを除けば、FVSTOF()はこれらの関数と同じものと考えることもできます。FUPDATEはNULLの値を持つレコードの要素を移動しないことを憶えていてください。

FVSTOF32()は、より多くのフィールドを持つ大きなview用のview32()型付きバッファで定義されたviewのために使用されます。

戻り値

FVSTOF32()は正常終了時には、FML-REC内のFML-STATUSにFOKを設定します。

エラーが発生した場合は、FML-STATUSは0以外の値に設定されます。

エラー

次の条件が発生すると、FVSTOF()は異常終了し、FML-STATUSに次の値を設定します。

[FALIGNERR]

[FNOTFLD]

[FEINVAL]

[FBADACM]

[FBADVIEW]

関連項目

『Oracle Tuxedo ATMI FML関数リファレンス』の「FML関数の紹介」、viewfile(5)

TPABORT(3cbl)

名前

TPABORT() - 現在のOracle Tuxedo ATMIのトランザクションの中断

形式

01 TPTRXDEF-REC.
  COPY TPTRXDEF.
 
01 TPSTATUS-REC.
  COPY TPSTATUS.
 
CALL "TPABORT" USING TPTRXDEF-REC TPSTATUS-REC.

説明

TPABORT()は、トランザクションの中止を指定します。この関数が終了すると、そのトランザクションでなされたリソースへの変更内容はすべて取り消されます。TPCOMMIT()と同様、このルーチンは、トランザクションのイニシエータからしか呼び出せません。参加リソース(つまり、サービス・ルーチン)は、トランザクションを中断したい場合には、TPFAILを付けてTPRETURN()を呼び出します。

未処理の応答に対する通信ハンドルが存在するときにTPABORT()を呼び出すと、このルーチンの終了時にトランザクションは中断し、呼出し側のトランザクションに関連する通信ハンドルは以後無効になります。呼出し側のトランザクションと無関係の通信ハンドルは有効なままです。

トランザクション・モードの会話サーバーに対してオープン接続がある場合、TPABORT()はTPEV-DISCONIMMイベントをサーバーに送ります(そのサーバーが接続の制御権を有するかどうかに関係なく)。TPBEGIN()の前に、あるいはTPNOTRAN設定を付けて(つまり、トランザクション・モードにない状態で)オープンした接続は、影響を受けません。

現時点では、TPABORT()の引数TPTRXDEF-RECは将来使用するために予約されています。

戻り値

TPABORT()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPABORT()は異常終了し、TP-STATUSに次の値を設定します。

[TPEINVAL]

[TPEHEURISTIC]

[TPEHAZARD]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

注意事項

TPBEGIN()、TPCOMMIT()およびTPABORT()を使用してOracle Tuxedo ATMIのトランザクションを記述する際には、XAインタフェースに準拠した(および呼出し側に適切にリンクされている)リソース・マネージャの行う作業がトランザクションとしてのプロパティを備えていることを忘れないようにすることが重要です。トランザクションで行われるその他の処理内容は、TPCOMMIT()やTPABORTの影響を受けません。

関連項目

TPBEGIN(3cbl)、TPCOMMIT(3cbl)、TPGETLEV(3cbl)

TPACALL(3cbl)

名前

TPACALL() - サービスへのメッセージの非同期送信を行うルーチン

形式

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

説明

TPACALL()は、TPSVCDEF-REC内のSERVICE-NAMEで指定されているサービスにリクエスト・メッセージを送ります。このリクエストは、以前になされたTPSPRIO()の呼出しで変更されていないかぎり、SERVICE-NAMEに定義されている優先度で送信されます。DATA-RECは、送信するメッセージであり、TPTYPE-REC内のLENは、DATA-RECに入るデータの大きさを指定します。ただし、DATA-RECが長さの指定を必要としないタイプのレコードである場合LENは無視されます(0でかまいません)。TPTYPE-REC内のREC-TYPEがSPACESの場合は、DATA-RECおよびLENは無視され、リクエストはデータ部なしで送信されます。REC-TYPEがSTRINGで、LENが0の場合は、リクエストはデータ部なしで送信されます。DATA-RECのREC-TYPEおよびSUB-TYPEは、SERVICE-NAMEが認識するREC-TYPEおよびSUB-TYPEのいずれかと一致しなければなりません。トランザクション・モードにあるときに送信されるリクエストごとに、最終的には対応する応答が受信されなければならないことに注意してください。

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

TPNOTRAN

TPTRAN

TPNOREPLY

TPREPLY

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPSIGRSTRT

TPNOSIGRSTRT

戻り値

TPACALL()は正常終了時には、TP-STATUSに[TPOK]を設定します。また、TPSVCDEF-RECにTPREPLYが設定されている場合には、TPCALL()は、COMM-HANDLEに通信ハンドルを返します。このハンドルは、送信したリクエストに対する応答を受信する際に使用できる有効なハンドルです。

エラー

次の条件が発生すると、TPACALL()は失敗し、TP-STATUSに次の値を設定します。特に説明がなければ、この障害は呼出し側のトランザクションには影響しません。

[TPEINVAL]

[TPENOENT]

[TPEITYPE]

[TPELIMIT]

[TPETRAN]

[TPETIME]

[TPEBLOCK]

[TPGOTSIG]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

関連項目

TPCALL(3cbl)、TPCANCEL(3cbl)、TPGETRPLY(3cbl)、TPGPRIO(3cbl)、TPSPRIO(3cbl)

TPADVERTISE(3cbl)

名前

TPADVERTISE() - サービス名の公開を行うルーチン

形式

01 SVC-NAME PIC X(127).
01 PROGRAM-NAME PIC X(32).
01 TPSTATUS-REC.
COPY TPSTATUS.

CALL "TPADVERTISE" USING SVC-NAME PROGRAM-NAME TPSTATUS-REC.

説明

TPADVERTISE()を使用するとサーバーは提供するサービスを公開することができます。デフォルトの設定では、サーバーのサービスは、サーバーのブート時に公開され、サーバーの停止時にその公開が解除されます。

複数サーバー単一キュー(MSSQ)セットに属するすべてのサーバーは、同じサービス・セットを提供しなければなりません。これらのルーチンは、MSSQセットを共有する全サーバーを公開することによってこの規則を適用します。

TPADVERTISE()は、サーバー(または、呼出し側のMSSQセットを共有するサーバー・セット)のSVC-NAMEを公開します。SVC-NAMEの長さは127文字以内にしてください。これに、SPACESを指定することはできません。(「UBBCONFIG(5)」のSERVICESの項を参照。)これより長い名前は127文字に切り詰められます。ユーザーは、切り詰められた名前が他のサービス名と同じにならないように注意する必要があります。PROGRAM-NAMEはOracle Tuxedo ATMIのサービス・プログラムの名前です。このプログラムは、SVC-NAMEに対するリクエストをサーバーが受け取ったときに起動されます。PROGRAM-NAMEにSPACESを指定することはできません。

SVC-NAMEがすでにサーバーに対して公開されていて、PROGRAM-NAMEがその現在のプログラムと一致する場合(すでに公開されていた名前と切り詰められた名前が一致する場合を含む)、TPADVERTISE()は正常終了します。ただし、SVC-NAMEがすでにサーバーに対して公開されていても、PROGRAM-NAMEが現在のプログラムと一致しない場合には(すでに公開されていた名前と切り詰められた名前が一致する場合も含む)、エラーが返されます。

戻り値

TPADVERTISE() TPADVERTISE()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPADVERTISE()は異常終了し、TP-STATUSに次の値を設定します。

[TPEINVAL]

[TPELIMIT]

[TPEMATCH]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

移植性

RS6000上のAIXでは、最初のCOBOLオブジェクト・ファイルで提供されるどのサービスもシンボル表で利用できません。buildserverコマンドで-sオプションを指定してサービス名を特定し、サービス名がTPADVERTISE()により実行時に公開されるようにする必要があります。

関連項目

TPUNADVERTISE(3cbl)

TPBEGIN(3cbl)

名前

TPBEGIN() - Oracle Tuxedo ATMIのトランザクションを開始するルーチン

形式

01 TPTRXDEF-REC.
  COPY TPTRXDEF. 
 
01 TPSTATUS-REC.
  COPY TPSTATUS. 
 
CALL "TPBEGIN" USING TPTRXDEF-REC TPSTATUS-REC.

説明

Oracle Tuxedoシステムにおけるトランザクションは、完全に成功するか、あるいは何も影響を残さない1つの論理的な作業単位の定義として使用されます。トランザクションにより、多くのプロセスで(そして、多分様々なサイトで)行われる作業を1つの分割できない単位として扱うことができます。トランザクションの開始プロセスはTPBEGIN()とともに、TPCOMMIT()またはTPABORT()を使用して、トランザクション内での処理を記述します。いったんTPBEGIN()が呼び出されると、他のプロセスとの通信は、後のプロセス(つまりサーバー)をトランザクション・モードにすることができます(つまり、サーバーの作業はトランザクションの一部となります)。トランザクションに参加する制御スレッドは参加リソースと呼ばれます。トランザクションには、必ず1つの実行元があり、いくつかの参加リソースをもつことができます。TPCOMMIT()またはTPABORT()を呼び出せるのは、トランザクションの実行元だけです。参加リソースは、それらがTPRETURN()を呼び出したときに、TPSVCDEF-RECの設定によってトランザクションの結果に影響することがあります。トランザクション・モードに入ると、サーバーに出されたサービス・リクエストはすべて、トランザクションの一部として処理されます(明示的にリクエスタからのそれ以外の指定がない場合)。

また、会話型サーバーに対して確立されたオープン接続があるときにプログラムがトランザクションを起動しても、これらの接続はトランザクション・モードには変わりません。これは、TPCONNECT()の呼出し時にTPNOTRAN設定を指定したことと同じです。

T-OUTは、トランザクションのタイムアウトまでの時間を最低T-OUT秒にすることを指定します。トランザクションはタイムアウト時間を経過した後は、異常終了します。T-OUTの値が0であると、トランザクションにはシステムが許す最大時間(秒単位)のタイムアウト値が与えられます。つまり、このときのタイムアウト値は、システムが定義する符号なしlong型の最大値になります。

戻り値

TPBEGIN()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPBEGIN()は異常終了し、TP-STATUSに次の値を設定します。

[TPEINVAL]

[TPETRAN]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

注意事項

TPBEGIN()、TPCOMMIT()、およびTPABORT()を使用してOracle Tuxedo ATMIのトランザクションを記述する際には、XAインタフェースに準拠した(および呼出し側に適切にリンクされている)リソース・マネージャが行う作業がトランザクションとしてのプロパティを備えていることを覚えておくことが重要です。トランザクションで行われるその他の処理内容は、TPCOMMIT()やTPABORT()の影響を受けません。そのリソース・マネージャが行った処理がOracle Tuxedo ATMIのトランザクションの一部となるよう、XAインタフェースを満たすリソース・マネージャをサーバーにリンクする方法については、「buildserver(1)」を参照してください。

関連項目

TPABORT(3cbl)、TPCOMMIT(3cbl)、TPGETLEV(3cbl)、TPSCMT(3cbl)

TPBROADCAST(3cbl)

名前

TPBROADCAST() - 名前によって通知をブロードキャストする

形式

01 TPBCTDEF-REC.
  COPY TPBCTDEF. 
 
01 TPTYPE-REC.
  COPY TPTYPE. 
 
01 DATA-REC.
  COPY User data. 
 
01 TPSTATUS-REC.
  COPY TPSTATUS. 
 
CALL "TPBROADCAST" USING TPBCTDEF-REC TPTYPE-REC DATA-REC TPSTATUS-REC.

説明

tpbroadcast()は、クライアント・プロセスやサーバー・プロセスがシステム内に登録されているクライアントに非請求メッセージを送ることができるようにします。ターゲット・クライアント・セットは、tpbroadcast()に渡されるワイルドカード以外の識別子すべてと一致するクライアントで構成されます。識別子の指定にワイルドカードを使用できます。

LMID、USRNAMEおよびCLTNAMEは、すべてTPBCTDEF-RECに入り、ターゲット・クライアント・セットの選択に使用する論理識別子です。論理識別子のSPACES値はその引数のワイルドカードとなります。ワイルドカード引数は、そのフィールドの全クライアント識別子と一致します。各識別子は、システムが有効とみなすよう定義されたサイズの制約事項を満たさなければなりません。つまり、各識別子の長さは0 - 30文字にする必要があります。

リクエストのデータ部は、DATA-RECによって識別され、TPTYPE-REC内のLENは、送信するDATA-RECの大きさを指定します。ただし、DATA-RECが長さの指定を必要としないタイプのレコードである場合LENは無視されます(0でかまいません)。TPTYPE-REC内のREC-TYPEがSPACESの場合、DATA-RECおよびLENは無視され、データ部なしでリクエストが送られます。

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

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPSIGRSTRT

TPNOSIGRSTRT

戻り値

TPBROADCAST()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPBROADCAST()はブロードキャスト・メッセージをアプリケーション・クライアントに送信せず、TP-STATUSに次の値を設定します。

[TPEINVAL]

[TPETIME]

[TPEBLOCK]

[TPGOTSIG]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

移植性

TPNOTIFY()に記述されているインタフェースはすべて、ネイティブ・サイトのUNIXシステム・ベースのプロセッサ上で利用できます。さらに、ルーチンTPBROADCAST()とTPCHKUNSOL()およびルーチンTPSETUNSOL()は、UNIXおよびMS-DOSワークステーション・プロセッサ上で利用できます。

使用方法

シグナル・ベースの通知方法を選択したクライアントは、シグナルに関する制約から、システムがシグナルで通知を制御することはできません。このような状態で通知がなされた場合、システムは、選択されたクライアントに対する通知方法をディップ・インに切り替えることを示すログ・メッセージを生成し、以後、クライアントにはディップ・イン方式で通知が行われることになります。(通知方法の詳細については、「UBBCONFIG(5)」の中のRESOURCESセクションのNOTIFYパラメータの説明を参照してください)。

クライアントのシグナル通知は、常にシステムによって行われるので、元の通知呼出しがどこで行われるかにかかわらず、通知の形態は一貫しています。したがって、シグナル・ベースの通知を使用するには次の条件が必要です。

アプリケーション管理者のIDは、そのアプリケーションの構成ファイルで識別されます。

あるクライアントに対してシグナル・ベースの通知方法を選択すると、いくつかのATMI呼出しは異常終了します。TPSIGRSTRTの指定がなければ、非請求メッセージを受け取るため、TPGOTSIG()を返します。通知方法の選択については、「UBBCONFIG(5)」および「TPINITIALIZE(3cbl)」を参照してください。

関連項目

TPINITIALIZE(3cbl)、TPNOTIFY(3cbl)、TPTERM(3cbl)、UBBCONFIG(5)

TPCALL(3cbl)

名前

TPCALL() - サービスへのメッセージの同期送信を行うルーチン

形式

01 TPSVCDEF-REC.
 COPY TPSVCDEF. 
 
01 ITPTYPE-REC.
 COPY TPTYPE. 
 
01 IDATA-REC.
 COPY User data. 
 
01 OTPTYPE-REC.
 COPY TPTYPE. 
 
01 ODATA-REC.
 COPY User data. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS. 
 
CALL "TPCALL" USING TPSVCDEF-REC ITPTYPE-REC IDATA-REC OTPTYPE-REC ODATA-REC TPSTATUS-REC.

説明

TPCALL()はリクエストを送り、それと同期してその応答を待ちます。このルーチンへの呼出しは、TPACALL()を呼び出した後即座にTPGETRPLY()を呼び出すのと同じことです。TPCALL()は、TPSVCDEF-REC内のSERVICE-NAMEで指定するリクエスト/レスポンス型サービスにリクエストを送ります。このリクエストは、以前になされたTPSPRIO()の呼出しで変更されていないかぎり、SERVICE-NAMEに定義されている優先度で送信されます。リクエストのデータ部分は、IDATA-RECによって指定され、ITPTYPE-REC内のLENは、送信するIDATA-RECの大きさを指定します。なお、IDATA-RECは、長さの指定を必要としないタイプのレコードを指している場合、ITPTYPE-REC内のLENは無視されます(0でかまいません)。ITPTYPE-REC内のREC-TYPEがSPACESの場合には、IDATA-RECおよびITPTYPE-REC内のLENは無視され、データ部なしでリクエストが送信されます。ITPTYPE-REC内のREC-TYPEがSTRINGのときにITPTYPE-REC内のLENが0の場合にも、データ部なしでリクエストが送信されます。ITPTYPE-REC内のREC-TYPEおよびITPTYPE-REC内のSUB-TYPEは、SERVICE-NAMEが認識するREC-TYPEおよびSUB-TYPEのいずれかと一致しなければなりません。

ODATA-RECは応答が読み込まれる場所を指定し、入力時のOTPTYPE-REC内のLENはODATA-RECに移動されるべき最大バイト数を示します。同じレコードを送信と受信の両方に使用する場合には、ODATA-RECをIDATA-RECにREDEFINEDしてください。TPCALL()の正常終了時には、OTPTYPE-REC内のLENには、ODATA-RECに実際に移動されたバイト数が入ります。OTPTYPE-REC内のREC-TYPEおよびSUB-TYPEには、それぞれ応答のタイプおよびサブタイプが入っています。応答がODATA-RECより大きい場合は、ODATA-RECにはこのレコードに入るバイト数分のみが入ります。応答の残りは破棄され、TPCALL()はTPTRUNCATE()を設定します。

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

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

TPNOTRAN

TPTRAN

TPNOCHANGE

TPCHANGE

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPSIGRSTRT

TPNOSIGRSTRT

戻り値

TPCALL()は正常終了時には、TP-STATUSに[TPOK]を設定します。TP-STATUSにTPOKまたはTPESVCFAILが設定されると、TPSTATUS-REC内のAPPL-RETURN-CODEにTPRETURN()の一部として送信されたアプリケーション定義の値が入ります。

着信メッセージの大きさが入力時にLENに指定されたものより大きい場合は、TPTRUNCATE()が設定され、LEN分のデータのみがODATA-RECに移動されて残りのデータは破棄されます。

エラー

次の条件が発生すると、TPCALL()は失敗し、TP-STATUSに次の値を設定します。特に説明がなければ、この障害は呼出し側のトランザクションには影響しません。

[TPEINVAL]

[TPENOENT]

[TPEITYPE]

[TPEOTYPE]

[TPETRAN]

[TPETIME]

[TPESVCFAIL]

[TPESVCERR]

[TPEBLOCK]

[TPGOTSIG]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

関連項目

TPACALL(3cbl)、TPFORWAR(3cbl)、TPGPRIO(3cbl)、TPRETURN(3cbl)、TPSPRIO(3cbl)

TPCANCEL(3cbl)

名前

TPCANCEL() - 未処理の応答の通信ハンドルを取り消す

形式

01 TPSVCDEF-REC.
  COPY TPSVCDEF. 
 
01 TPSTATUS-REC.
  COPY TPSTATUS. 
 
CALL "TPCANCEL" USING TPSVCDEF-REC TPSTATUS-REC.

説明

TPCANCEL()は、TPACALL()が戻す通信ハンドル、TPSVCDEF-REC内のCOMM-HANDLEを取り消します。トランザクションに対応する通信ハンドルを取り消そうとすると、エラーになります。

正常終了の場合、COMM-HANDLEは以後無効になり、COMM-HANDLEのために受信する応答はすべて、警告なしに破棄されます。

戻り値

TPCANCEL()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPCANCEL()は異常終了し、TP-STATUSに次の値を設定します。

[TPEBADDESC]

[TPETRAN]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

関連項目

TPACALL(3cbl)

TPCHKAUTH(3cbl)

名前

TPCHKAUTH() - Oracle Tuxedo ATMIアプリケーションへの結合に認証が必要かどうかをチェックする

形式

01 TPAUTDEF-REC.
 COPY TPAUTDEF. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS.
 
 CALL "TPCHKAUTH" USING TPAUTDEF-REC TPSTATUS-REC.

説明

TPCHKAUTH()は、アプリケーションの構成が認証を必要としているかどうかを調べます。これは一般に、TPINITIALIZE()を呼び出す前にアプリケーション・クライアントが使用して、ユーザーからのパスワードの入力を必要とするかどうかを判別します。

戻り値

TPCHKAUTH()は正常終了時には、TP-STATUSに[TPOK]を設定し、TPAUTDEF-RECに次のいずれかの値を設定します。

TPNOAUTH

TPSYSAUTH

TPAPPAUTH

エラー

次の条件が発生すると、TPCHKAUTH()は異常終了し、TP-STATUSに次の値を設定します。

[TPESYSTEM]

[TPEOS]

移植性

TPCHKAUTH()に記述されているインタフェースは、UNIXシステムおよびMS-DOSオペレーティング・システム上でサポートされています。

関連項目

TPINITIALIZE(3cbl)

TPCHKUNSOL(3cbl)

名前

TPCHKUNSOL() - 非請求メッセージをチェックする

形式

01 MSG-NUM PIC S9(9) COMP-5. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS. 
 
CALL "TPCHKUNSOL" USING MSG-NUM TPSTATUS-REC.

説明

tpchkunsol()は、クライアントが非請求メッセージの検査を行うときに使用します。クライアントでシグナル・ベースの通知方法を使用してこのルーチンを呼び出しても、何も行われず、ただちに終了します。このルーチンを呼び出すと、アプリケーションで定義された非請求メッセージ処理ルーチンへの呼出しがOracle Tuxedo ATMIのライブラリによって行われることがあります。

戻り値

TPCHKUNSOL()は正常終了時には、TP-STATUSに[TPOK]を設定し、ディスパッチされた非請求メッセージの数をMSG-NUMに返します。

エラー

次の条件が発生すると、TPCHKUNSOL()は異常終了し、TP-STATUSに次の値を設定します。

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

移植性

TPNOTIFY()に記述されているインタフェースはすべて、ネイティブ・サイトのUNIXシステム・ベースのプロセッサ上で利用できます。さらに、ルーチンTPBROADCAST()とTPCHKUNSOL()およびルーチンTPSETUNSOL()は、UNIXおよびMS-DOSワークステーション・プロセッサ上で利用できます。

シグナル・ベースの通知方法を選択したクライアントは、シグナルに関する制約から、システムがシグナルで通知を制御することはできません。このような状態で通知がなされた場合、システムは、選択されたクライアントに対する通知方法をディップ・インに切り替えることを示すログ・メッセージを生成し、以後、クライアントにはディップ・イン方式で通知が行われることになります。(通知方法の詳細については、「UBBCONFIG(5)」の中のRESOURCESセクションのNOTIFYパラメータの説明を参照してください)。

クライアントのシグナル通知は、常にシステムによって行われるので、元の通知呼出しがどこで行われるかにかかわらず、通知の形態は一貫しています。したがって、シグナル・ベースの通知を使用するには次の条件が必要です。

アプリケーション管理者のIDは、アプリケーション構成の一部として識別されます。

あるクライアントに対してシグナル・ベースの通知方法を選択すると、いくつかのATMI呼出しは異常終了します。TPSIGRSTRTの指定がなければ、非請求メッセージを受け取るため、TPGOTSIG()を返します。通知方法の選択については、「UBBCONFIG(5)」および「TPINITIALIZE(3cbl)」を参照してください。

関連項目

TPBROADCAST(3cbl)、TPINITIALIZE(3cbl)、TPNOTIFY(3cbl)、TPSETUNSOL(3cbl)

TPCLOSE(3cbl)

名前

TPCLOSE() - Oracle Tuxedo ATMIのリソース・マネージャのクローズ

形式

01 TPSTATUS-REC.
 COPY TPSTATUS. 
 
CALL "TPCLOSE" USING TPSTATUS-REC.

説明

tpclose()は、呼出し側とそれにリンクされたリソース・マネージャとの関係を絶ちます。リソース・マネージャはクローズの内容がそれぞれで異なるため、個々のリソース・マネージャをクローズするために必要な情報を構成ファイルに記述します。

リソース・マネージャがすでにクローズしている場合(つまり、tpclose()が1回以上呼び出された)、何も処理は行われず、正常終了を示すコードが返されます。

戻り値

TPCLOSE()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPCLOSE()は異常終了し、TP-STATUSに次の値を設定します。

[TPERMERR]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

関連項目

TPOPEN(3cbl)

TPCOMMIT(3cbl)

名前

TPCOMMIT() - 現在のOracle Tuxedo ATMIのトランザクションのコミット

形式

01 TPTRXDEF-REC.
COPY TPTRXDEF.

01 TPSTATUS-REC.
COPY TPSTATUS.

CALL "TPCOMMIT" USING TPTRXDEF-REC TPSTATUS-REC

説明

tpcommit()はトランザクションの終了(コミット)を示します。tpcommit()は2フェーズ・コミット・プロトコルを使用して、参加リソース間の調整をとります。tpcommit()は、トランザクションの開始プロセスからのみ呼び出されます。いずれかの参加リソースがトランザクションをコミットできない場合(たとえば、TPFAIL()を付けてTPRETURN()を呼び出した場合など)、そのトランザクション全体が中断し、TPCOMMIT()は異常終了します。つまり、そのトランザクションに関連して各プロセスが行ったすべての作業は取り消されます。すべての参加リソースがトランザクションの中のそれぞれが担当する部分のコミットを決定した場合、この決定は安定したストレージに記録された後、すべての参加リソースに対して作業のコミットが要求されます。

TP-COMMIT-CONTROL特性の設定条件に従って(TPSCMT()参照)、コミットの決定が記録された後、あるいは2フェーズ・コミット・プロトコルが完了した後、TPCOMMIT()は正常に終了することができます。コミットの決定が記録された後、第2フェーズが完了する前(TP-CMT-LOGGED)にTPCOMMIT()が終了する場合、すべての参加リソースはトランザクションのために行った作業内容をコミットすることに同意しているとみなし、第2フェーズでトランザクションをコミットする約束を果たす必要があります。ただし、TPCOMMIT()は第2フェーズが完了する前に終了してしまうので、参加リソースの中には、このルーチンが正常終了した場合でも、トランザクションの担当部分をヒューリスティックに(コミットの決定とは矛盾するような方法で)完了するといった状況が発生してしまいます。

TP-COMMIT-CONTROL特性が2フェーズ・コミット・プロトコルの完了(TP-CMT-COMPLETE)後にTPCOMMIT()が終了するように設定されている場合、その戻り値にはトランザクションの正確なステータスが反映されます(つまり、トランザクションがヒューリスティックに完了したかどうか)。

なお、トランザクションに1つのリソース・マネージャしか関与していない場合には、1フェーズ・コミットが行われます(つまり、リソース・マネージャには、コミットできるかどうかの確認はされず、単にコミットの指示が出されます)。そして、この場合、TP-COMMIT-CONTROL特性はコミットには関係せず、TPCOMMIT()はヒューリスティックな結果(もしあれば)を返します。

未処理の応答の通信ハンドルがあるときにTPCOMMIT()が呼び出されると、TPCOMMIT()の終了時にトランザクションは中断し、呼出し側のトランザクションに対応する通信ハンドルがすべて無効になります。呼出し側のトランザクションに対応していない通信ハンドルは有効なままです。

呼出し側のトランザクションに対応する接続がすべてクローズしてから、TPCOMMIT()を呼び出さなければなりません。そうでないと、[TPEABORT]が返され、トランザクションは中断し、TPEV-DISCONIMMイベントを示して各接続が不規則に切断されます。TPBEGIN()の前またはTPNOTRANを設定して(つまり、トランザクション・モードでない状態で)オープンされた接続は、TPCOMMIT()またはTPABORT()の影響を受けません。

現時点では、TPCOMMIT()の引数TPTRXDEF-RECは将来使用するために予約されています。

戻り値

TPCOMMIT()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPCOMMT()は異常終了し、TP-STATUSに次の値を設定します。

[TPEINVAL]

[TPETIME]

[TPEABORT]

[TPEHEURISTIC]

[TPEHAZARD]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

注意事項

TPBEGIN()、TPCOMMIT()、およびTPABORT()を使用してOracle Tuxedo ATMIのトランザクションを記述する際には、XAインタフェースに準拠した(および呼出し側に適切にリンクされている)リソース・マネージャが行う作業のみがトランザクションとしてのプロパティを備えていることを忘れないようにすることが重要です。トランザクションで行われるその他の処理内容は、TPCOMMIT()やTPABORT()の影響を受けません。そのリソース・マネージャが行った処理がOracle Tuxedo ATMIのトランザクションの一部となるよう、XAインタフェースを満たすリソース・マネージャをサーバーにリンクする方法については、「buildserver(1)」を参照してください。

関連項目

TPABORT(3cbl)、TPBEGIN(3cbl)、TPCONNECT(3cbl)、TPGETLEV(3cbl)、TPRETURN(3cbl)、TPSCMT(3cbl)

TPCONNECT(3cbl)

名前

TPCONNECT() - 会話接続の確立

形式

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

説明

TPCONNECT()により、プログラムは会話サービス、TPSVCDEF-REC内のSERVICE-NAMEとの半二重接続を設定できます。この名前は、会話型サーバーがポストした会話型サービス名の1つでなければなりません。

呼出し側は、接続セットアップ処理の一部として、アプリケーション定義データを受信サービス・ルーチンに渡すことができます。呼出し側がデータを渡すことを選択した場合には、DATA-RECにはデータが入り、TPTYPE-REC内のLENは送信するレコードの大きさを指定します。ただし、DATA-RECが長さの指定を必要としないタイプのレコードである場合LENは無視されます(0でかまいません)。TPTYPE-REC内のREC-TYPEがSPACESである場合、DATA-RECおよびLENは無視されます(アプリケーション・データは会話サービスに渡されません)。REC-TYPEおよびTPTYPE-REC内のSUB-TYPEは、SERVICE-NAMEが認識するタイプおよびサブタイプと一致しなければなりません。

TPSVCSTART()の正常終了時には会話サービスはDATA-RECおよびLENを受け取るので、TPCONNECT()が送信したデータを獲得するために、会話サービスがTPRECV()を呼び出すことはありません。

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

TPNOTRAN

TPTRAN

TPSENDONLY

TPRECVONLY

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPSIGRSTRT

TPNOSIGRSTRT

戻り値

TPCONNECT()は正常終了時には、TP-STATUSに[TPOK]を設定し、TPSVCDEF-REC内のCOMM-HANDLEに通信ハンドルを返します。このハンドルは、以降の呼出しにおいて接続を参照するために使用されます。

エラー

次の条件が発生すると、TPCONNECT()は失敗し、TP-STATUSに次の値を設定します。特に説明がなければ、この障害は呼出し側のトランザクションには影響しません。

[TPEINVAL]

[TPENOENT]

[TPEITYPE]

[TPELIMIT]

[TPETRAN]

[TPETIME]

[TPGOTSIG]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

関連項目

TPDISCON(3cbl)、TPRECV(3cbl)、TPSEND(3cbl)

TPDEQUEUE(3cbl)

名前

TPDEQUEUE() - キューからメッセージを取り出すルーチン

形式

01 TPQUEDEF-REC.
 COPY TPQUEDEF. 
 
01 TPTYPE-REC.
 COPY TPTYPE. 
 
01 DATA-REC.
 COPY User data. 
 
01 TPSTATUS-REC.
 COPY STATDEF. 
 
CALL "TPDEQUEUE" USING TPQUEDEF-REC TPTYPE-REC DATA-REC TPSTATUS-REC.

説明

TPDEQUEUE()は、キュー・スペースQSPACE-NAME内のQNAMEで指定されるキューから、処理するメッセージを取り出します。

省略時設定では、キューの先頭のメッセージが取り出されます。キュー上のメッセージの順序は、そのキューの作成時に定義されます。アプリケーションは、MSGIDを使用してメッセージ識別子を指定するか、またはCORRIDを使用して相関識別子を指定することにより、特定のメッセージをキューから取り出すことをリクエストできます。メッセージを現在取り出せない場合には、アプリケーションはメッセージを待つことを示すために、TPQUEDEF-REC設定を使用することもできます。また、TPQUEDEF-REC構造体を使用して、メッセージを読み出してもそれがキューから削除されないようにしたり、キュー上の相対位置が変更されないようにすることが可能です。この後のこのレコードについての説明を参照してください。

DATA-RECは、キューから取り出されたメッセージの読込み先を指定します。入力時のLENは、DATA-RECへ移動する最大バイト数を示します。正常終了時には、LENには、DATA-RECへ移動された実際のバイト数が入ります。REC-TYPEおよびSUB-TYPEには、それぞれ応答のタイプおよびサブタイプが入ります。応答がDATA-RECより大きい場合は、DATA-RECにはこのレコードに入るバイト数分のみが入ります。応答の残りは破棄され、TPDEQUEUE()は異常終了して[TPTRUNCATE]を返します。

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

呼出し側がトランザクション・モードにあり、TPTRANが設定されている場合は、メッセージは、トランザクション・モードでキューから取り出されます。この結果、TPDEQUEUEが正常終了して呼出し側のトランザクションが正常にコミットされると、リクエストはキューから削除されます。呼出し側のトランザクションが、明示的に、またはトランザクション・タイムアウトあるいは何らかの通信エラーの結果としてロールバックされると、メッセージはキュー上に残されます。つまり、キューからのメッセージの削除もロールバックされます。同じトランザクション内で、同じメッセージの登録と取出しを行うことはできません。

呼出し側がトランザクション・モードにないか、またはTPNOTRANが設定されている場合は、メッセージはトランザクション・モードではキューから取り出されません。トランザクション・モードでない場合に通信エラーまたはタイムアウトが発生した場合、アプリケーションには、メッセージが正しくキューから取り出されたかどうかがわからず、メッセージが失われることがあります。

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

TPNOTRAN

TPTRAN

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPNOCHANGE

TPCHANGE

TPSIGRSTRT

TPNOSIGRSTRT

TPDEQUEUE()が正常終了すると、アプリケーションは、TPQUEDEF-REC構造体を使用してメッセージに関する追加情報を取得できます。この情報には、キューから取り出されたメッセージのメッセージ識別子、すべての応答または失敗メッセージに付随して、発信元がメッセージと元のリクエストを結び付けることができるようにする相関識別子、メッセージが送られるサービスの品質、メッセージの応答が送られるサービスの品質、応答が要求された場合は応答キューの名前、およびメッセージをキューから取り出すときの失敗に関する情報をアプリケーションが登録できる失敗キューの名前が含まれます。これらについて以下に説明します。

制御構造体

TPQUEDEF-RECは、アプリケーション・プログラムが、キューからのメッセージの取出しに関連する情報を渡したり、取得したりするために使用します。TPQUEDEF-RECの設定は、構造体の他のどの要素が有効であるかを示すために使用されます。

TPDEQUEUE()への入力時には、次の要素をTPQUEDEF-RECに設定できます。

05 MSGID    PIC X(32).
05 CORRID   PIC X(32).

TPDEQUEUE()の入力情報を制御するTPQUEDEF-RECの有効な設定の一覧を次に示します。

TPQGETNEXT

TPQGETBYMSGID

TPQGETBYCORRID

TPQWAIT

TPQPEEK

TPDEQUEUE()からの出力時には、次の要素がTPQUEDEF-RECに設定されます。

05 PRIORITY                PIC S9(9) COMP-5. 
05 MSGID                   PIC X(32). 
05 CORRID                  PIC X(32). 
05 TPQUEQOS-DELIVERY-FLAG  PIC S9(9) COMP-5. 
05 TPQUEQOS-REPLY-FLAG     PIC S9(9) COMP-5. 
05 REPLYQUEUE              PIC X(127). 
05 FAILUREQUEUE            PIC X(127). 
05 DIAGNOSTIC              PIC S9(9) COMP-5. 
05 CLIENTID OCCURS 4 TIMES PIC S9(9) COMP-5 
05 APPL-RETURN-CODE        PIC S9(9) COMP-5. 
05 APPKEY                  PIC S9(9) COMP-5.

TPDEQUEUE()からの出力情報を制御するTPQUEDEF-RECの有効な設定を次に示します。どの設定でも、TPDEQUEUE()の呼出し時に真の場合、メッセージがキューに入れられたときに提供された値が、レコード内の対応する要素に格納され、その設定は真のままになります。値を利用できない、つまりメッセージがキューに入れられたときに値が提供されていない場合、またはTPDEQUEUE()の呼出し時に設定が真でない場合、その値が真でない状態でTPDEQUEUE()は完了します。

TPQPRIORITY

TPQMSGID

TPQCORRID

TPQDELIVERYQOS

TPQREPLYQOS

TPQREPLYQ

TPQFAILUREQ

TPQUEDEF-RECの残りの設定は、TPDEQUEUE()が呼び出されると、TPQNOTOP、TPQNOBEFOREMSGID、TPQNOTIME_ABS、TPQNOTIME_REL、TPQNOEXPTIME_ABS、TPQNOEXPTIME_REL、およびTPQNOEXPTIME_NONEに設定されます。

TPDEQUEUE()の呼出しが異常終了し、TP-STATUSにTPEDIAGNOSTICが設定された場合は、異常終了の原因を示す値がDIAGNOSTICに返されます。返される可能性のある値は、この後の「診断」の項で定義しています。

また、TPDEQUEUE()呼出しが正常終了した場合の出力時には、APPKEYにアプリケーション認証キーが設定され、CLIENTIDにリクエストの発信元であるクライアントの識別子が設定され、APPL-RETURN-CODEにメッセージ登録時に設定されたユーザー戻りコードが設定されます。

戻り値

TPDEQUEUE()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPDEQUEUE()は異常終了し、TP-STATUSに次の値を設定します。特に説明がなければ、この障害は呼出し側のトランザクションには影響しません。

[TPEINVAL]

[TPENOENT]

[TPEOTYPE]

[TPTRUNCATE]

[TPETIME]

[TPEBLOCK]

[TPGOTSIG]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

[TPEDIAGNOSTIC]

診断

次の診断値は、キューからのメッセージの取出し中に返されます。

[QMEINVAL]

[QMEBADRMID]

[QMENOTOPEN]

[QMETRAN]

[QMEBADMSGID]

[QMESYSTEM]

[QMEOS]

[QMEABORTED]

[QMEPROTO]

[QMEBADQUEUE]

[QMENOMSG]

[QMEINUSE]

[QMESHARE]

関連項目

qmadmin(1)、TPENQUEUE(3cbl)、TMQUEUE(5)

TPDISCON(3cbl)

名前

TPDISCON() - 会話接続の切断

形式

01 TPSVCDEF-REC.
COPY TPSVCDEF.

01 TPSTATUS-REC.
COPY TPSTATUS.

CALL "TPDISCON" USING TPSVCDEF-REC TPSTATUS-REC.

説明

TPDISCON()は、通信ハンドル、TPSVCDEF-REC内のCOMM-HANDLEで指定された接続を即座に切断し、接続の他方の側でTPEV-DISCONIMMイベントを生成します。

TPDISCON()は会話の開始プロセスからしか呼び出せません。TPDISCON()は、呼出しに使用された通信ハンドルに対応する会話サービスの中からは呼び出せません。会話サービスはTPRETURN()を使用して、会話の該当部分が完了したことを通知しなければなりません。同様に、会話サービスとのやりとりを行うプログラムがTPDISCON()を発行できる場合でも、正しい結果を保証するためには、そのサービスにTPRETURN()で接続を切断させるようにしてください。接続の起動元がサーバーである場合には、TPRETURN()を使用し正常に切断を行うこともできます。接続の起動元がトランザクション・モードにある場合、TPCOMMIT()またはTPABORT()を使用して、接続を正常に終了させることができます。

TPDISCON()を使用すると、接続はただちに切断されます(つまり、正常終了ではなく、中断)。したがって、あて先に届いていないデータは失われます。TPDISCON()は、接続の他方の側のプログラムが呼出し側のトランザクションに参加している場合でも発行されます。この場合、このトランザクションは中断します。また、呼出し側は、TPDISCON()が呼び出されるときにその接続の制御権をもっている必要はありません。

戻り値

TPDISCON()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPDISCON()は異常終了し、TP-STATUSに次の値を設定します。

[TPEBADDESC]

[TPETIME]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

関連項目

TPABORT(3cbl)、TPCOMMIT(3cbl)、TPCONNECT(3cbl)、TPRECV(3cbl)、TPRETURN(3cbl)、TPSEND(3cbl)

TPENQUEUE(3cbl)

名前

TPENQUEUE() - メッセージをキューに登録するルーチン

形式

01 TPQUEDEF-REC.
 COPY TPQUEDEF. 
 
01 TPTYPE-REC.
 COPY TPTYPE. 
 
01 DATA-REC.
 COPY User data. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS. 
 
CALL "TPENQUEUE" USING TPQUEDEF-REC TPTYPE-REC DATA-REC TPSTATUS-REC. 

説明

TPENQUEUE()は、キュー・スペースQSPACE-NAME内のQNAMEで指定されるキューにメッセージを格納します。キュー・スペースは、キューを集めたもので、そのうちの1つのキューがQNAMEでなければなりません。

メッセージがOracle Tuxedo ATMIシステムのサーバーを対象としている場合、QNAMEは、サーバーによって提供されるサービスの名前に一致します。システムが提供するサーバーであるTMQFORWARD(5)は、メッセージをキューから取り出し、キューと同じ名前のサービスを提供するサーバーにそのメッセージを転送するデフォルトの機構となります。発信元が応答を期待していた場合は、転送されたサービス・リクエストへの応答は、特に指定されている場合を除き、発信元のキューに格納されます。発信元は、後で応答メッセージをキューから取り出します。キューは、任意の2つのOracle Tuxedo ATMIのプロセス間(クライアントやサーバー)における信頼性の高いメッセージ転送機構用としても使用できます。この場合、キューの名前はサービス名とは一致せず、メッセージ転送のための名前に関連します。

メッセージのデータ部分は、DATA-RECによって指定され、TPTYPE-REC内のLENは、キューに登録するDATA-RECの大きさを指定します。ただし、DATA-RECが長さの指定を必要としないタイプのレコードである場合LENは無視されます(0でかまいません)。TPTYPE-REC内のREC-TYPEがSPACESの場合には、DATA-RECおよびLENは無視され、データ部なしでメッセージがキューに登録されます。TPTYPE-REC内のREC-TYPEおよびSUB-TYPEは、QSPACE-NAMEが認識するREC-TYPEおよびSUB-TYPEのいずれかと一致しなければなりません。

メッセージは、QSPACE-NAME用に定義された優先度が事前のTPSPRIO()の呼出しによって無効化されていないかぎり、QSPACE-NAME用の優先度でキューに登録されます。

呼出し側がトランザクションにあり、TPTRANが設定されている場合は、メッセージは、トランザクション・モードでキューに登録されます。この結果、TPENQUEUE()が正常終了して呼出し側のトランザクションが正常にコミットされると、メッセージは、トランザクションの完了後に処理されることが保証されます。呼出し側のトランザクションが、明示的に、またはトランザクション・タイムアウトあるいはなんらかの通信エラーの結果としてロールバックされると、メッセージはキューから削除されます(つまり、キューへのメッセージの登録もロールバックされます)。同じトランザクション内で同じメッセージの登録と取出しを行うことはできません。

呼出し側がトランザクション・モードにないか、またはTPNOTRANが設定されている場合は、メッセージはトランザクション・モードではキューに登録されません。TPENQUEUE()が正常終了した後は、サブミットされたメッセージがキューに登録されたことが保証されます。トランザクション・モードでないときに通信エラーまたはタイムアウトが発生した場合、アプリケーションには、メッセージが正しくキューに格納されたかどうかがわかりません。

メッセージが処理される順序は、以下に説明するように、アプリケーションによってTPQUEDEF-RECを介して制御されます。デフォルトのキューの順序付けは、キューの作成時に設定されます。

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

TPNOTRAN

TPTRAN

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPSIGRSTRT

TPNOSIGRSTRT

キューへのメッセージ登録に関する追加情報は、TPQUEDEF-RECを介して指定できます。この情報には、デフォルトのキューの順序付けを無効にしてキューの先頭または登録済みのメッセージの前にメッセージを登録するための値、キューからメッセージを取り出すまでの絶対時間または相対時間、メッセージが期限切れになりキューから削除される絶対時間または相対時間、メッセージ配信サービスの品質、メッセージが応答する際のサービス品質、メッセージとそのメッセージに関連付けられた応答または失敗メッセージを結び付けるときに役立つ相関識別子、応答を登録するキューの名前、およびすべての失敗メッセージを登録するキューの名前が含まれます。

制御パラメータ

TPQUEDEF-RECは、アプリケーション・プログラムが、キューへのメッセージの登録に関連する情報を渡したり、取得したりするために使用します。設定は、レコード内のどの要素が有効であるかを示すために使用されます。

TPENQUEUE()への入力時には、次の要素をTPQUEDEF-RECに設定できます。

05 DEQ-TIME                 PIC S9(9) COMP-5. 
05 PRIORITY                 PIC S9(9) COMP-5. 
05 MSGID                    PIC X(32). 
05 CORRID                   PIC X(32). 
05 TPQUEQOS-DELIVERY-FLAG   PIC S9(9) COMP-5. 
05 TPQUEQOS-REPLY-FLAG      PIC S9(9) COMP-5. 
05 EXP-TIME                 PIC S9(9) COMP-5.
05 REPLYQUEUE               PIC X(127). 
05 FAILUREQUEUE             PIC X(127). 
05 APPL-RETURN-CODE         PIC S9(9) COMP-5.

次の値は、どの値がTPQUEDEF-RECに設定されるかを示します。

TPQTOP

TPQBEFOREMSGID

TPQTIME-ABS

TPQTIME-REL

TPQPRIORITY

TPQCORRID

TPQREPLYQ

TPQFAILUREQ

TPQDELIVERYQOS
TPQREPLYQOS

TPQEXPTIME-ABS

TPQEXPTIME-REL

TPQEXPTIME-NONE

TPQNOEXPTIME

また、APPL-RETURN-CODEにユーザー戻り値を設定することができます。この値は、メッセージをキューから取り出すアプリケーションに戻されます。

TPENQUEUE()からの出力時には、次の要素がTPQUEDEF-RECに設定されます。

05 MSGID      PIC X(32). 
05 DIAGNOSTIC PIC S9(9) COMP-5.

TPENQUEUE()からの出力情報を制御するTPQUEDEF-RECの有効な設定を次に示します。TPENQUEUE()の呼出し時にこの設定が真の場合、/QサーバーTMQUEUE(5)は、レコード内の対応する要素にメッセージ識別子を格納します。TPENQUEUE()の呼出し時にこの設定が真でない場合、TMQUEUE()は、レコード内の対応する要素にメッセージ識別子を格納しません。

TPQMSGID

制御構造体の残りのメンバーは、TPENQUEUE()への入力では使用しません。

TPENQUEUE()の呼出しが異常終了し、TP-STATUSにTPEDIAGNOSTICが設定された場合は、異常終了の原因を示す値がDIAGNOSTICに返されます。返される可能性のある値は、この後の「診断」の項で定義しています。

戻り値

TPENQUEUE()は正常終了時には、TP-STATUSに[TPOK]を設定します。

エラー

次の条件が発生すると、TPENQUEUE()は失敗し、TP-STATUSに次の値を設定します。特に説明がなければ、この障害は呼出し側のトランザクションには影響しません。

[TPEINVAL]

[TPENOENT]

[TPETIME]

[TPEBLOCK]

[TPGOTSIG]

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

[TPEDIAGNOSTIC]

診断

次の診断値は、キューへのメッセージの登録中に返されます。

[QMEINVAL]

[QMEBADRMID]

[QMENOTOPEN]

[QMETRAN]

[QMEBADMSGID]

[QMESYSTEM]

[QMEOS]

[QMEABORTED]

[QMEPROTO]

[QMEBADQUEUE]

[QMENOSPACE]

[QMERELEASE]

[QMESHARE]

関連項目

qmadmin(1)、TPDEQUEUE(3cbl)、TPSPRIO(3cbl)、TMQFORWARD(5), TMQUEUE(5)

TPFORWAR(3cbl)

名前

TPFORWAR() - Oracle Tuxedo ATMIのサービス・リクエストを別のルーチンに転送

形式

01 TPSVCDEF-REC.
 COPY TPSVCDEF. 
 
01 TPTYPE-REC.
 COPY TPTYPE. 
 
01 DATA-REC.
 COPY User data. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS.
 
COPY TPFORWAR REPLACING TPSVCDEF-REC BY TPSVCDEF-REC
 TPTYPE-REC BY TPTYPE-REC
 DATA-REC BY DATA-REC
 TPSTATUS-REC BY TPSTAUS-REC 

説明

TPFORWAR()を使用すると、サービス・ルーチンはクライアントのリクエストを別のサービス・ルーチンに転送して処理させることができます。TPFORWAR()にはEXIT PROGRAM文が含まれるので、Oracle Tuxedo ATMIのディスパッチャに制御を確実に正しく返すために、TPFORWAR()はそれが起動されたルーチンと同じルーチンの中から呼び出されなければなりません。つまり、TPFORWAR()をサービス・ルーチンのサブ・プログラムから呼び出してはなりません。制御がOracle Tuxedo ATMIのディスパッチャに返されないからです。TPFORWAR()を会話サービスの中から呼び出すことはできません。

このルーチンは、DATA-RECに入っているデータを使用してTPSVCDEF-REC内のSERVICE-NAMEによって指定されるサービスにリクエストを転送します。リクエストを転送するサービス・ルーチンは応答を受け取りません。リクエストの転送が終わると、サービス・ルーチンはOracle Tuxedo ATMIのディスパッチャに戻り、他の作業を行える状態になります。なお、転送されたリクエストからの応答は期待しないため、このリクエストは、リクエストを転送するサービスと同じ実行可能プログラム内の任意のサービス・ルーチンに、エラーなしで転送することができます。

サービス・ルーチンがトランザクション・モードであると、このルーチンはトランザクションの呼出し側の部分を、そのトランザクションの起動元がTPCOMMIT()またはTPABORT()のいずれかを出したときに完了できるような状態にします。トランザクションがサービス・ルーチンの実行中にTPBEGIN()により明示的に開始された場合、このトランザクションをTPCOMMIT()またはTPABORT()で終了させてから、TPFORWAR()を呼び出さなければなりません。このため、転送チェーンに関与するすべてのサービスは、トランザクション・モードで起動するか、あるいはどれもトランザクション・モードでは起動しないようにします。

転送チェーンの最後のサーバーは、TPRETURN()を使用してリクエストの発信元に応答を返します。要約して言えば、TPFORWAR()は待機しているリクエスタに応答を返す役割を別のサーバーに転送するわけです。

TPFORWAR()は、サービス・ルーチンが出したサービス・リクエストから期待されるすべての応答を受け取った後、呼び出すようにしてください。受信されていない未終了の応答は、受信後、Oracle Tuxedo ATMIのディスパッチャによって自動的に取り除かれます。さらに、以後、これらの応答の通信ハンドルは無効になり、リクエストはSERVICE-NAMEに転送されません。

DATA-RECは送信されるレコードであり、TPTYPE-REC内のLENは、送信するDATA-RECの大きさを指定します。ただし、DATA-RECが長さの指定を必要としないタイプのレコードである場合LENは無視されます(0でかまいません)。TPTYPE-REC内のREC-TYPEがSPACESの場合、DATA-RECおよびLENは無視され、長さゼロのデータでリクエストがデータ長ゼロで送信されます。REC-TYPEがSTRINGで、LENが0の場合は、リクエストはデータ部なしで送信されます。

サービス・ルーチンの作成者はTPFORWAR()の呼出し後は制御を保持しないので、シグナル・リスタートによるブロッキング送信が使用されます(つまり、TPSIGRSTRT)。現時点では、TPSVCDEF-RECの設定は将来使用するために予約されており、指定しても無視されます。

戻り値

サービス・ルーチンは、呼出し側であるOracle Tuxedo ATMIディスパッチャには値を返しません。このためTP-STATUSは設定されません。

エラー

このルーチンに渡されたパラメータの処理中またはそのルーチン自体の処理中にエラーが発生した場合、失敗メッセージが最初のリクエスタに戻されます(応答が送信されない場合を除く)。未終了の応答または従属接続がある場合や呼出し側のトランザクションに中断のみマークが付けられた場合には、失敗メッセージの原因となる障害であるとみなされます。リクエスタは、エラーを示すTPESVCERR()によって、失敗メッセージを検出します。このようなエラーが発生した場合、呼出し側のデータは送信されません。また、このエラーが原因で、呼出し側の現在のトランザクションに中断のマークが付けられます。

サービス・ルーチンの処理中あるいはリクエストの転送中にトランザクション・タイムアウトになると、TPCALL()またはTPGETRPLY()で応答を待つリクエスタはTPETIMEエラーを受け取ります。サービスがトランザクション内部で失敗すると、そのトランザクションはタイムアウトになり、TX_ROLLBACK_ONLY状態になります。また、そのトランザクションの後続のATMI呼出しは、すべてTPETIMEで異常終了します。待ち状態にあるリクエスタは、どのようなデータも受信しません。しかし、サービス・ルーチンはTPRETURN()またはTPFORWAR()を使用して終了させるようになっています。会話型サービス・ルーチンの場合、TPRETURN()を使用しなければならず、TPFORWAR()を使用することはできません。

サービス・ルーチンがTPRETURN()もTPFORWAR()も使用しない場合、またはTPFORWAR()が会話サーバーから呼び出された場合、そのサーバーはログ・ファイルに警告メッセージを出力し、最初のリクエスタにサービス・エラーを戻します。また、従属接続に対するオープン接続はすべて、ただちに切断され、未終了の非同期応答は無効とマークされます。サーバーが障害発生時にトランザクション・モードにあった場合は、そのトランザクションには中断のみマークが付けられます。TPRETURN()またはTPFORWAR()のいずれかがサービス・ルーチンとは別に(たとえば、クライアント、TPSVRINIT()、TPSVRDONE()などから)使用されても、これらのルーチンは何も影響を及ぼさず終了するだけです。

関連項目

TPCONNECT(3cbl)、TPRETURN(3cbl)

TPGBLKTIME(3cbl)

名前

TPGBLKTIME() - 以前にTPSBLKTIMEで設定されたブロック時間値を取得する

形式

01 TPBLKDEF-REC.
	COPY TPBLKDEF.
01 TPSTATUS-REC.
	COPY TPSTATUS.

CALL “TPGBLKTIME” USING TPBLKDEF-REC TPSTATUS-REC.

説明

TPGBLKTIME()は、以前に設定された1秒あたりのブロック時間値を取得し、この値をTBLKDEF-RECのBLKTIMEに格納します。TPGBLKTIME()にブロック時間フラグ値を指定した場合、それに一致するフラグ値が設定されていないと戻り値0が返されます。ブロック時間フラグ値として0未満の値を指定するとエラーが発生します。

次に、有効なTPBLKDEF-RECフラグ値の一覧を示します。

TPBLK-NEXT

TPBLK-ALL

TPGBLKTIME()にブロック時間フラグ値(TPBLK-NEXTまたはTPBLK-ALL)を指定しない場合、以前にブロック時間フラグ値(TPBLK-NEXTまたはTPBLK-ALL)を指定したTPSBLKTIME()呼出しで設定された次のブロッキングAPIのブロック時間値、またはシステム全体のデフォルト・ブロック時間値が返されます。

戻り値

TPGBLKTIME()は正常終了時には[TPOK]にTP-STATUSを設定し、以前に設定されたブロック時間値があればその値をTBLKDEF-RECのBLKTIMEに返します。BLKTIME値0は、以前に設定された入力ブロック時間値が存在しないことを示します。

エラー

次の条件が発生すると、TPGBLKTIMEは失敗し、TP-STATUSに次のいずれかの値を設定します。失敗しても、トランザクション・タイムアウト値には影響しません。

[TPEINVAL]

[TPESYSTEM]

関連項目

TPCALL(3cbl)、TPCONNECT(3cbl)、TPRECV(3cbl)、TPSBLKTIME(3cbl)、UBBCONFIG(5)

TPGETCTXT(3cbl)

名前

TPGETCTXT() - 現在のアプリケーション関連のコンテキスト識別子を取り出す

形式

01 TPCONTEXTDEF-REC.
   COPY TPCONTEXTDEF.
 
01 TPSTATUS-REC.
   COPY TPSTATUS.
 
CALL "TPGETCTXT" USING TPCONTEXTDEF-REC TPSTATUS-REC.

説明

TPGETCTXT()は、現在のアプリケーション関連のコンテキストを表す識別子を検索し、その識別子をTPCONTEXTDEF-REC内のCONTEXTに入れます。一般的なCOBOLアプリケーションの処理は次のとおりです。

TPGETCTXT()は、シングル・コンテキスト・アプリケーションおよびマルチコンテキスト・アプリケーションで呼び出すことができます。

戻り値

TPGETCTXTは正常終了時には、TP-STATUSに[TPOK]を設定し、プログラムのコンテキスト識別子をTPCONTEXTDEF-REC内のCONTEXTに入れます。CONTEXTには現在のコンテキストIDが設定されます。これは、次のいずれかで表されます。

エラー

TPGETCTXTの異常終了時には、TP-STATUSに次のいずれかの値が設定されます。

[TPEINVAL]

[TPESYSTEM]

[TPEOS]

関連項目

「COBOLアプリケーション・トランザクション・モニター・インタフェースの紹介」、TPSETCTXT(3cbl)

TPGETLEV(3cbl)

名前

TPGETLEV() - Oracle Tuxedo ATMIのトランザクションの進行状況のチェック

形式

01 TPTRXLEV-REC.
 COPY TPTRXLEV. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS. 
 
CALL "TPGETLEV" USING TPTRXLEV-REC TPSTATUS-REC.

説明

TPGETLEV()は現在のトランザクション・レベルを呼出し側に返します。現時点では、定義されているレベルはTP-NOT-IN-TRANとTP-IN-TRANだけです。

戻り値

TPGETLEV()は正常終了時には、TP-STATUSに[TPOK]を設定し、TPTRXLEV-RECに値を設定します。TPTRXLEV-RECに設定される値は、進行中のトランザクションがないことを示すTP-NOT-IN-TRAN、トランザクションが進行中であることを示すTP-IN-TRANのいずれかです。

エラー

次の条件が発生すると、TPGETLEV()は異常終了し、TP-STATUSに次の値を設定します。

[TPEPROTO]

[TPESYSTEM]

[TPEOS]

注意事項

TPBEGIN()、TPCOMMIT()、およびTPABORT()を使用してOracle Tuxedo ATMIのトランザクションを記述する際には、XAインタフェースに準拠した(および呼出し側に適切にリンクされている)リソース・マネージャが行う作業のみがトランザクションとしてのプロパティを備えていることを忘れないようにすることが重要です。トランザクションで行われるその他の処理内容は、TPCOMMIT()やTPABORT()の影響を受けません。そのリソース・マネージャが行った処理がOracle Tuxedo ATMIのトランザクションの一部となるよう、XAインタフェースを満たすリソース・マネージャをサーバーにリンクする方法については、「buildserver(1)」を参照してください。

関連項目

TPABORT(3cbl)、TPBEGIN(3cbl)、TPCOMMIT(3cbl)、TPSCMT(3cbl)

TPGETRPLY(3cbl)

名前

TPGETRPLY() - 非同期メッセージからの応答の取得

形式

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

説明

TPGETRPLY()は、事前に送られたリクエストの応答を戻します。TPGETRPLY()は、特定のリクエストに対する応答、または取得可能なすべての応答を戻します。選択可能なこの2つについて、ここで説明します。

DATA-RECは、応答を読み取る場所を指定し、TPTYPE-REC内のLENは、DATA-RECに移動すべき最大バイト数を示します。また、TPTYPE-RECのREC-TYPEを指定する必要があります。TPGETRPLY()の正常終了時には、実際にDATA-RECに移動されたバイト数がLENに入り、TPTYPE-REC内のREC-TYPEおよびSUB-TYPEには、それぞれデータのタイプおよびサブタイプが入ります。応答がDATA-RECより大きい場合は、DATA-RECにはこのレコードに入るバイト数分のみが入ります。応答の残りは破棄され、TPGETRPLY()はTPTRUNCATE()を設定します。

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

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

TPGETANY

TPGETHANDLE

TPNOCHANGE

TPCHANGE

TPNOBLOCK

TPBLOCK

TPNOTIME

TPTIME

TPSIGRSTRT

TPNOSIGRSTRT

特に説明がなければ、COMM-HANDLEは対応する応答が受信された後は、無効になります。

戻り値

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

エラー

次の条件が発生すると、TPGETRPLY()は異常終了し、TP-STATUSを以下のように設定します。TPGETHANDLEが設定されている場合は、特に明記されないかぎり、COMM-HANDLEは無効になります。TPGETANYが設定されていると、COMM-HANDLEは障害を起こした応答の通信ハンドルを示します。応答を取り出せるようになる前にエラーが発生した場合には、COMM-HANDLEは0です。また、特に明記しないかぎり、異常終了は呼出し側のトランザクションが存在していても、それには影響しません。

[TPEINVAL]

[TPEOTYPE]

[TPEBADDESC]

[TPETIME]

[TPESVCFAIL]

[TPESVCERR]

[TPEBLOCK]

[TPGOTSIG]