Tuxedo 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() を介して最終的な応答が送信された時点で終了します。

このため、会話サーバによって実行される会話サービスは、要求を受け取った時点で開始され、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 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 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 通りあります。第 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(15).

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(15).
05 QSPACE-NAME                   PIC X(15).
05 REPLYQUEUE                    PIC X(15).
05 FAILUREQUEUE                  PIC X(15).
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(31).
05 NAME-2              PIC X(31).
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.
*  正常実行
  88 TX-OK                 VALUE 0.
*  正常実行
  88 TX-OUTSIDE            VALUE -1.
*  アプリケーションが RM ローカル トランザクションにある。
  88 TX-ROLLBACK           VALUE -2.
*  トランザクションがロールバックされた。
  88 TX-MIXED              VALUE -3.
*  トランザクションが部分的にコミットされ、部分的に
*  ロールバックされた。
  88 TX-HAZARD             VALUE -4.
*  トランザクションが部分的にコミットされ、部分的に
*  ロールバックされた可能性がある。
  88 TX-PROTOCOL-ERROR     VALUE -5.
*  ルーチンが不適切なコンテキストで呼び出された。
  88 TX-ERROR              VALUE -6.
*  一時的なエラー
  88 TX-FAIL               VALUE -7.
*  致命的なエラー
  88 TX-EINVAL             VALUE -8.
*  無効な引数が指定された。
  88 TX-COMMITTED          VALUE -9.
*  トランザクションがヒューリスティックにコミットされた。
  88 TX-NO-BEGIN           VALUE -100.
*  トランザクションはコミットされ、新しいトランザクションは
*  開始できなかった。
  88 TX-ROLLBACK-NO-BEGIN  VALUE -102.
*  トランザクションはロールバックされ、新しいトランザクションは
*  開始できなかった。
  88 TX-MIXED-NO-BEGIN     VALUE -103.
*  混合条件が発生し、新しいトランザクションが開始できなかった。
  88 TX-HAZARD-NO-BEGIN    VALUE -104.
*  ハザードがあり、新しいトランザクションが開始できなかった。
  88 TX-COMMITTED-NO-BEGIN VALUE -109.
*  ヒューリスティックにコミットされ、トランザクションが
*  開始できなかった。

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

*
* TXINFDEF.cbl
*
05 XID-REC.
*  XID レコード
10 FORMAT-ID            PIC S9(9) COMP-5.
*  FORMAT-ID に値 -1 が入っている場合、XID は 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.
*  トランザクション モード設定
  88 TX-NOT-IN-TRAN            VALUE 0.
  88 TX-IN-TRAN                VALUE 1.
05 COMMIT-RETURN        PIC S9(9) COMP-5.
*  Commit_return 設定
  88 TX-COMMIT-COMPLETED       VALUE 0.
  88 TX-COMMIT-DECISION-LOGGED VALUE 1.
05 TRANSACTION-CONTROL  PIC S9(9) COMP-5.
*  Transaction_control 設定
  88 TX-UNCHAINED              VALUE 0.
  88 TX-CHAINED                VALUE 1.
05 TRANSACTION-TIMEOUT  PIC S9(9) COMP-5.
*  Transaction_timeout 値
  88 NO-TIMEOUT                VALUE 0.
05 TRANSACTION-STATE    PIC S9(9) COMP-5.
*  Transaction_state 情報
  88 TX-ACTIVE                 VALUE 0.
  88 TX-TIMEOUT-ROLLBACK-ONLY  VALUE 1.
  88 TX-ROLLBACK-ONLY          VALUE 2.

ATMI の状態遷移

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

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

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

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

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

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

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

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

次の表は、TPACALL() が返す 1 つの要求ハンドルの状態を示すものです。

次の表は、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 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 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() は COBOL のレコードからフィールド化バッファにデータを転送します。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 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 が設定されている場合には、TPACALL() は、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(15).
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 の長さは 15 文字以内にしてください。これに、SPACES を指定することはできません (UBBCONFIG(5) の SERVICES セクションを参照)。これより長い名前は、15 文字までで切り捨てられてしまいます。このため、切り捨てられた名前が他のサービス名と同じにならないよう、注意が必要です。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(15).
05 FAILUREQUEUE            PIC X(15).
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() が呼び出されるときにその接続の制御権をもっている必要はありません。