C 言語を使用した Oracle Tuxedo アプリケーションのプログラミング

イベント ベースのクライアントおよびサーバのコーディング

ここでは、以下の内容について説明します。

イベントの概要

イベント ベースの通信では、特定の状況 (イベント) が発生すると、Oracle Tuxedo システムのプロセスに通知されます。

Oracle Tuxedo システムには、次の 2 種類のイベント ベースの通信があります。

非請求イベント

非請求イベントは、メッセージを待たないクライアント プログラム、またはメッセージを要求しないクライアント プログラムとの通信に使用されるメッセージです。

ブローカ イベント

ブローカ イベントを使用すると、メッセージの受信と配信を行う「無名」ブローカを介して、クライアントとサーバが透過的に通信できるようになります。このブローカを使用した通信は、Oracle Tuxedo システムの基本要素であるクライアント/サーバ通信パラダイムの 1 つです。

イベント ブローカは、イベント ポスト メッセージを受信してフィルタ処理し、それらのメッセージをサブスクライバに配布する Oracle Tuxedo のサブシステムです。ポスト元とは、特定のイベントが発生したときにそれをイベント ブローカに報告 (ポスト) する Oracle Tuxedo システムのプロセスです。サブスクライバとは、特定のイベントがポストされたときに常に通知する必要がある Oracle Tuxedo システムのプロセスです。

Oracle Tuxedo システムでは、サービスの要求側と提供側の数の比率が一定である必要はなく、任意の数のポスト元が任意の数のサブスクライバに対してメッセージ バッファをポストできます。ポスト元は単にイベントをポストするだけで、情報を受信するプロセスや、情報の処理方法については関知しません。サブスクライバには指定されたイベントが通知されますが、その情報のポスト元は通知されません。このように、イベント ブローカでは位置透過性が実現されます。

通常、イベント ブローカ アプリケーションは、例外イベントを処理します。アプリケーションの設計者は、アプリケーション内でどのイベントを例外イベントとして定義して監視する必要があるのかを決定しなければなりません。たとえば、銀行業務アプリケーションでは、高額な引き出しがあったときにイベントがポストされるように設定し、すべての引き出しに対してイベントがポストされる必要はありません。また、すべてのユーザがそのイベントをサブスクライブする必要はありません。支店長だけに通知すれば十分です。

通知処理

イベントがポストされると、イベント ブローカはイベントをサブスクライブしているクライアントまたはサーバに対して、1 つ以上の通知処理を行います。次の表は、イベント ブローカが行う通知処理の種類を示しています。

アプリケーション管理者は、Oracle Tuxedo の管理用 API を使用して、次の通知処理を行う EVENT_MIB(5) エントリを作成できます。

EVENT_MIB(5) の詳細については、『Oracle Tuxedo のファイル形式とデータ記述方法』を参照してください。

イベント ブローカ サーバ

TMUSREVT は Oracle Tuxedo システムで提供されるサーバで、ユーザ定義のイベントに対するイベント ブローカとして動作します。TMUSREVT はイベント レポート用のメッセージ バッファを処理し、それらのバッファをフィルタ処理して配信します。イベントのブローカ処理を行うには、Oracle Tuxedo アプリケーション管理者がこれらのサーバを 1 つ以上起動する必要があります。

TMSYSEVT は Oracle Tuxedo システムで提供されるサーバで、システム定義のイベントに対するイベント ブローカとして動作します。TMSYSEVT と TMUSREVT は似ています。ただし、別個のサーバが提供されているので、アプリケーション管理者はこの 2 種類のイベント通知に対して異なる処理方法を取り入れることができます。詳細については、『Oracle Tuxedo アプリケーションの設定』を参照してください。

システム定義のイベント

Oracle Tuxedo システムでは、システムの警告と障害に関連する定義済みの特定のイベントが検出されてポストされます。これらの処理はイベント ブローカによって行われます。たとえば、システム定義のイベントには、設定の変更、状態の変更、接続の障害、マシンの分断などがあります。イベント ブローカによって検出されるシステム定義のイベントの全リストについては、『Oracle Tuxedo のファイル形式とデータ記述方法』の「EVENTS(5)」を参照してください。

システム定義のイベントは、Oracle Tuxedo システムで定義されているので、ポストする必要はありません。システム定義のイベント名は、アプリケーション定義のイベント名とは異なり、必ずドット (「.」) で始まります。アプリケーション定義のイベント名をドットで始めることはできません。

クライアントとサーバは、システム定義のイベントをサブスクライブできます。ただし、システム定義のイベントは、アプリケーション内のすべてのクライアントが使用するのではなく、主にアプリケーション管理者が使用します。

イベント ブローカをアプリケーションに組み込む場合、イベント ブローカが多数のサブスクライバに大量の配信を行うためのシステムではないことを考慮してください。発生するすべての動作に対してイベントをポストしないでください。また、すべてのクライアントとサーバがイベントをサブスクライブする必要はありません。イベント ブローカに負荷がかかると、システムのパフォーマンスに影響し、通知が行われなくなる場合があります。負荷を最小限にするには、『Oracle Tuxedo システムのインストール』で説明するように、アプリケーション管理者がオペレーティング システムの IPC リソースを慎重に調整する必要があります。

イベント ブローカ プログラミング インタフェース

イベント ブローカ プログラミング インタフェースは、ワークステーションを含むすべての Oracle Tuxedo システムのサーバ プロセスおよびクライアント プロセスに対して C 言語および COBOL 言語で使用できます。

プログラマは、次の処理をコーディングします。

サブスクライバへの通知方法にはいろいろな方法 (「通知処理」を参照) があり、イベントはフィルタ処理されます。通知処理とフィルタ処理は、プログラミング インタフェースと Oracle Tuxedo システムの管理用 API を使用して設定します。

非請求メッセージ ハンドラの定義

非請求メッセージ ハンドラ関数を定義するには、次の文法を使用して tpsetunsol(3c) 関数を呼び出します。

int
tpsetunsol(*myfunc)

Windows ベースのオペレーティング システムを実行している場合、以下のような非請求メッセージ ハンドラ関数を宣言する必要があります。

  void _TMDLLENTRY CustomerUnsolFunc(char *data, long len, long flags)

Windows ベースのオペレーティング システムでは、Tuxedo ライブラリと使用するコード間で適切な呼び出し規約を適用するために _TMDLLENTRY マクロが必要になります。

Unix システムの場合は、_TMDLLENTRY マクロは NULL 文字列に展開するため必要ありません。

tpsetunsol() 関数の引数は、次の表で説明する myfunc だけです。

クライアントが非請求メッセージを受信すると、そのメッセージと共にコールバック関数がディスパッチされます。できる限りタスクが中断されないようにするには、非請求メッセージのハンドラ関数で最小限の処理しか行われないようにコーディングします。このようにすると、ハンドラ関数が待機中のプロセスにすぐに戻ることができます。

非請求メッセージの送信

Oracle Tuxedo システムでは、要求/応答型呼び出しまたは会話型通信の処理を妨げずに、クライアント プロセスに非請求メッセージを送信できます。

非請求メッセージは、名前、または以前に処理されたメッセージと共に受信した識別子を使用して、クライアント プロセスに送信できます。名前による送信には tpbroadcast(3c)、識別子による送信には tpnotify(3c) を使用します。tpbroadcast() で送信されるメッセージの発信元は、サービスまたは別のクライアントです。tpnotify() で送信されるメッセージの発信元は、サービスだけです。

名前によるメッセージのブロードキャスト

tpbroadcast(3c) を使用すると、アプリケーションの登録されたクライアントにメッセージが送信されます。TPBROADCAST ルーチンは、サービスまたは別のクライアントから呼び出すことができます。登録されたクライアントとは、tpinit() を呼び出したものの、まだ tpterm() を呼び出してはいないクライアントのことです。

tpbroadcast() 関数の呼び出しには、次の文法を使用します。

int
tpbroadcast(char *lmid, char *usrname, char *cltname, char *data, long len, long flags)

次の表は、tpbroadcast() 関数の引数を示しています。

次のサンプル コードは、すべてのクライアントを送信先として tpbroadcast() を呼び出す方法を示しています。送信メッセージは、STRING 型バッファ内にあります。

char *strbuf;
 
 if ((strbuf = tpalloc("STRING", NULL, 0)) == NULL) {
          error routine
          }
 
 (void) strcpy(strbuf, "hello, world");
 
 if (tpbroadcast(NULL, NULL, NULL, strbuf, 0, TPSIGRSTRT) == -1)
              error routine

識別子によるメッセージのブロードキャスト

tpnotify(3c) 関数を使用すると、以前に処理されたメッセージと共に受信した識別子を使用してメッセージがブロードキャストされます。TPNOTIFY ルーチンは、サービスからのみ呼び出すことができます。

tpnotify() 関数の呼び出しには、次の文法を使用します。

int
tpnotify(CLIENTID *clientid, char *data, long len, long flags)

次の表は、tpnotify() 関数の引数を示しています。

非請求メッセージの確認

クライアントが「ディップ イン」通知モードで実行されている場合に非請求メッセージがあるかどうかを確認するには、次の文法を使用して tpchkunsol(3c) 関数を呼び出します。

int
tpchkunsol()

この関数に引数はありません。

未処理のメッセージがある場合、tpsetunsol() で指定された非請求メッセージ処理関数が呼び出されます。処理が終了すると、この関数は処理した非請求メッセージの数、またはエラーを示す -1 を返します。

クライアントがシグナル ベースまたはスレッド ベースの通知モードで実行されている場合、またはクライアントが非請求メッセージを無視している場合にこの関数を呼び出すと、関数は何も処理を行わずにすぐに制御を戻します。

イベントのサブスクライブ

tpsubscribe(3c) 関数を使用すると、Oracle Tuxedo システムのクライアントまたはサーバがイベントをサブスクライブできるようになります。

サブスクライバは、非請求通知メッセージ、サービス呼び出し、高い信頼性のキュー、またはアプリケーション管理者が設定する別の通知方法によって、通知を受け取ります。別の通知方法の設定については、『Oracle Tuxedo アプリケーションの設定』を参照してください。

tpsubscribe() 関数の呼び出しには、次の文法を使用します。

long handle
tpsubscribe (char *eventexpr, char *filter, TPEVCTL *ctl, long flags)

次の表は、tpsubscribe() 関数の引数を示しています。

システム定義のイベントとアプリケーション定義のイベントは、tpsubscribe() 関数を使用してサブスクライブできます。

サブスクリプション、および MIB を更新するために Oracle Tuxedo システムのサーバ プロセスで実行されるサービス ルーチンは、信頼されたコードと見なされます。

非請求メッセージを使用した通知

サブスクライバが Oracle Tuxedo システムのクライアント プロセスであり、ctl に NULL が設定されている場合、クライアントがサブスクライブしているイベントがポストされると、イベント ブローカは次のようにサブスクライバに非請求メッセージを送ります。eventexpr に対して正常に評価されたイベント名がポストされると、イベント ブローカは対応付けられたフィルタ規則でポストされたデータを確認します。データがフィルタ規則で正しく評価された場合 (またはイベントにフィルタ規則がない場合)、サブスクライバはイベントと共にポストされたデータと非請求メッセージを受信します。

非請求メッセージを受け取るには、クライアントは tpsetunsol() 関数を使用して、非請求メッセージ処理ルーチンを登録しておく必要があります。

クライアントが非請求メッセージによってイベント通知を受け取った場合、終了する前にイベント ブローカのアクティブなサブスクリプションのリストからそのサブスクリプションを削除する必要があります。サブスクリプションの削除には tpunsubscribe() 関数を使用します。

サービス呼び出しまたは信頼できるキューを使用した通知

サービス呼び出しを使用したイベント通知では、アプリケーションの特定の条件に対して自動的に応答するようにプログラミングできます。高い信頼性のキューを使用したイベント通知では、イベント データが損失しないことが保証されます。また、サブスクライバがいつでもイベント データを取り出せるという柔軟性があります。

サブスクライバ (クライアント プロセスまたはサーバ プロセス) がイベント通知をサービス ルーチンまたは安定記憶領域のキューに送信する場合、tpsubscribe() の ctl パラメータが有効な TPEVCTL 構造体を指していることが必要です。

TPEVCTL 構造体には、次の情報が格納されています。

long   flags;
char   name1[32];
char   name2[32];
TPQCTL qctl;

次の表は、TPEVCTL 型バッファのデータ構造を示しています。

イベントに対するサブスクリプションの削除

tpunsubscribe(3c) 関数を使用すると、Oracle Tuxedo システムのクライアントまたはサーバがイベントに対するサブスクリプションを削除できます。

tpunsubscribe() 関数の呼び出しには、次の文法を使用します。

int
tpunsubscribe (long subscription, long flags)

次の表は、tpunsubscribe() 関数の引数を示しています。

イベントのポスト

tppost(3c) 関数を使用すると、Oracle Tuxedo のクライアントまたはサーバがイベントをポストできます。

tppost() 関数の呼び出しには、次の文法を使用します。

tppost(char *eventname, char *data, long len, long flags)

次の表は、tppost() 関数の引数を示しています。

次のサンプル コードは、Oracle Tuxedo システムの銀行業務のサンプル アプリケーション bankapp から引用したイベント ポストを示しています。この例は、WITHDRAWAL サービスの一部です。WITHDRAWAL サービスは、10,000 ドルを超える引き出しかどうかを確認し、また BANK_TLR_WITHDRAWAL イベントをポストします。

.
.
.
/* 関連するイベント ロジック */
static float evt_thresh = 10000.00 ; /* デフォルトのイベントしきい値 */
static char  emsg[200] ;  /* イベント ポスト ロジックで使用 */
.
.
.
/* BANK_TLR_WITHDRAWAL イベントをポストするかどうかの判定 */
if (amt < evt_thresh) {
     /* ポストするイベントはなし */
     tpreturn(TPSUCCESS, 0,transb->data , 0L, 0);
}
/* イベントをポストする準備 */
if ((Fchg (transf, EVENT_NAME, 0, "BANK_TLR_WITHDRAWAL", (FLDLEN)0) == -1) ||
(Fchg (transf, EVENT_TIME, 0, gettime(), (FLDLEN)0) == -1) ||
(Fchg (transf, AMOUNT, 0, (char *)&amt, (FLDLEN)0) == -1)) {
     (void)sprintf (emsg, "Fchg failed for event fields: %s",
     Fstrerror(Ferror)) ;
}
/* イベントをポスト */
else if (tppost ("BANK_TLR_WITHDRAWAL", /* イベント名 */
(char *)transf, /* データ */
0L,   /* 長さ */
TPNOTRAN | TPSIGRSTRT) == -1) {
/* イベント ブローカを使用できない場合、エラーを無視 */
     if (tperrno != TPENOENT)
     (void)sprintf (emsg, "tppost failed: %s", tpstrerror (tperrno));
}

このサンプル コードでは、アプリケーションで目立った状況が発生したことを示すために、イベントをイベント ブローカにポストしているだけです。特定のイベントに関心を持つクライアント (必要に応じて処理を行うクライアント) のイベントへのサブスクリプションは、別にコーディングします。

イベントのサブスクリプションの例

次のサンプル コードは、bankapp アプリケーション サーバの一部であり、このサーバは BANK_TLR_.* イベントをサブスクライブしています。この例には、前述の例の BANK_TLR_WITHDRAWAL イベントと、BANK_TLR_ で始まるそのほかのイベント名が含まれています。合致するイベントがポストされると、WATCHDOG サービスへの呼び出しを使用して、アプリケーションからサブスクライバにイベントが通知されます。

.
.
.
/* イベント サブスクリプション ハンドル */
static long sub_ev_largeamt = 0L ;
.
.
.
/* 'w' (WATCHDOG のしきい値) にデフォルト値を設定 */
(void)strcpy (amt_expr, "AMOUNT > 10000.00") ;
.
.
.
/*
 * 高額な引き出しが行われた場合に
 * 生成されるイベントをサブスクライブ
 */
evctl.flags = TPEVSERVICE ;
(void)strcpy (evctl.name1, "WATCHDOG") ;
/* サブスクライブ */
sub_ev_largeamt = tpsubscribe ("BANK_TLR_.*",amt_expr,&evctl,TPSIGRSTRT) ;
if (sub_ev_largeamt == -1L) {
     (void)userlog ("ERROR: tpsubscribe for event BANK_TLR_.* failed: %s",
     tpstrerror(tperrno)) ;
     return -1 ;
}
.
.
.
{
/* イベントへのサブスクリプションを削除 */
if (tpunsubscribe (sub_ev_largeamt, TPSIGRSTRT) == -1)
    (void)userlog ("ERROR: tpunsubscribe to event BANK_TLR_.* failed: %s",
    tpstrerror(tperrno)) ;
    return ;
}
/*
* BANK_TLR_.* イベントがポストされたときに呼び出されるサービス
*/
void
#if defined(__STDC__) || defined(__cplusplus)
WATCHDOG(TPSVCINFO *transb)
#else
WATCHDOG(transb)
TPSVCINFO *transb;
#endif
{
FBFR *transf; /* デコードされたメッセージのフィールド化バッファ */
/* TPSVCINFO データ バッファを指すポインタを設定 */
transf = (FBFR *)transb->data;
/* ログ エントリを標準出力に出力 */
(void)fprintf (stdout, "%20s|%28s|%8ld|%10.2f\n",
Fvals (transf, EVENT_NAME, 0),
Fvals (transf, EVENT_TIME, 0),
Fvall (transf, ACCOUNT_ID, 0),
*( (float *)CFfind (transf, AMOUNT, 0, NULL, FLD_FLOAT)) );
/* イベントのサブスクライバのサービス ルーチンから返されるデータはなし */
tpreturn(TPSUCCESS, 0,NULL, 0L, 0);
}