ヘッダーをスキップ
Oracle Coherenceクライアント・ガイド
リリース3.5
B56041-01
  目次
目次

戻る
戻る
 
次へ
次へ
 

4 C++クライアントの構成と使用

この章では、Coherence for C++の設定、Coherence*Extendの統合およびログ出力の構成の一般的な手順について説明します。

一般的な手順

Coherence for C++を構成して使用するには、次の7つの基本的な手順が必要です。

  1. Coherence for C++ APIを使用してC++アプリケーションを実装します。APIの詳細は、第5章「Coherence for C++ APIについて」を参照してください。

  2. アプリケーションをコンパイルおよびリンクします。

  3. パスを構成します。

  4. クライアント、およびクラスタにある1つ以上のJVMの両方にCoherence*Extendを構成します。

  5. クライアント、およびクラスタの中でCoherence*Extendのクラスタ・サービスを実行しているすべてのJVMにPOFコンテキストを構成します。

  6. Coherenceクラスタが稼働中であることを確認します。

  7. C++クライアント・アプリケーションを起動します。

これらの手順の詳細は、次の各項で説明します。

C++アプリケーションの実装

Coherence for C++に用意されているAPIを使用すると、データ、データ・イベント、データ処理などのCoherenceクラスタ・サービスに、Coherenceクラスタ外部からC++アプリケーションを使用してアクセスできます。

Coherence for C++ APIは、次のもので構成されています。

このライブラリを使用したC++アプリケーションは、Coherenceクラスタ内で稼働するCoherence*Extendのクラスタ・サービス・インスタンスに、高性能なTCP/IPベースの通信レイヤーを使用して接続できます。このライブラリからCoherence*Extendクラスタ・サービスにすべてのクライアント・リクエストが送信され、このサービスは実際のCoherenceクラスタ・サービス(パーティション・キャッシュ・サービス、レプリケーション・キャッシュ・サービスなど)に委任することで、クライアント・リクエストに応答します。

第5章「Coherence for C++ APIについて」では、このAPIにある主要なクラスの概要を説明しています。これらのクラスの詳細は、Coherence for C++のdocディレクトリにあるAPIそのものを参照してください。

アプリケーションのコンパイルとリンク

Coherence for C++を採用したアプリケーションをコンパイルできるプラットフォームのリストは、サポートされているプラットフォームとオペレーティング・システムに関するトピックを参照してください。

たとえば、次に示すWindows 32ビット・プラットフォーム用build.cmdファイルは、Coherence for C++のデモのファイルをビルド、コンパイルおよびリンクします。このファイルにある各変数の意味は次のとおりです。

このファイルは、これらの環境変数を設定した後、C++のコード・ファイルとヘッダー・ファイル、APIファイルおよびOPTファイルをコンパイルし、LOPT、Coherence for C++の共有ライブラリ、生成されたオブジェクト・ファイルおよびOUTファイルをリンクします。オブジェクト・ファイルを削除することで、この処理は終了します。build.cmdファイルの実行例を例4-1に示します。

例4-1 build.cmdファイルの実行例

@echo off
setlocal

set EXAMPLE=%1%

if "%EXAMPLE%"=="" (
   echo You must supply the name of an example to build.
   goto exit
   )

set OPT=/c /nologo /EHsc /Zi /RTC1 /MD /GR /DWIN32
set LOPT=/NOLOGO /SUBSYSTEM:CONSOLE /INCREMENTAL:NO
set INC=/I%EXAMPLE% /Icommon /I..\include
set SRC=%EXAMPLE%\*.cpp common\*.cpp
set OUT=%EXAMPLE%\%EXAMPLE%.exe
set LIBPATH=..\lib
set LIBS=%LIBPATH%\coherence.lib

echo building %OUT% ...
cl %OPT% %INC% %SRC%
link %LOPT% %LIBS% *.obj /OUT:%OUT%

del *.obj

echo To run this example execute 'run %EXAMPLE%'

:exit

パスの構成

Coherence for C++ライブラリへのコンフィギュレーション・パスを設定します。この手順では、ライブラリをポイントする環境変数を設定します。環境変数名とライブラリのファイル名は、使用しているプラットフォーム環境によって異なります。プラットフォームごとの環境変数名とライブラリ名の一覧は、「コンパイルとリンクの環境変数の設定」を参照してください。

Coherence*Extendの構成

Coherence*Extendを構成するには、クラスタ側とクライアント側両方のキャッシュ・コンフィギュレーション・ディスクリプタに適切な構成要素を追加します。クラスタ側のキャッシュ・コンフィギュレーション要素からCoherenceのDefaultCacheServerに対して、Coherence*Extendクライアントから受信したTCP/IPリクエストをリスニングするCoherence*Extendクラスタ・サービスを開始するように指示されます。クライアント側のキャッシュ・コンフィギュレーション要素は、クライアント・ライブラリによって、クラスタに接続するために使用されます。この構成では、クラスタの中でCoherence*Extendのクラスタ・サービスを実行している1台以上のサーバーのIPアドレスとポートを指定します。これにより、ライブラリをクラスタに接続できます。この構成では、接続やリクエストのタイムアウトなど、接続に関連する様々なパラメータも記述します。

クラスタでのCoherence*Extendの構成

Coherence*ExtendクライアントをCoherenceクラスタに接続するには、そのクラスタにある1つ以上のDefaultCacheServer JVMで、TCP/IP Coherence*Extendクラスタ・サービスを実行している必要があります。このサービスを実行するようにDefaultCacheServerを構成するには、そのDefaultCacheServerで使用するキャッシュ・コンフィギュレーション・ディスクリプタに、子にtcp-acceptor要素を持つproxy-scheme要素を追加する必要があります。

たとえば、例4-2のキャッシュ・コンフィギュレーション・ディスクリプタは、2つのクラスタ・サービスを定義します。これは、リモートCoherence*ExtendクライアントをTCP/IPでCoherenceクラスタに接続できるようにするサービス、および標準のパーティション・キャッシュ・サービスです。このディスクリプタはDefaultCacheServerで使用しているため、クラスタ・サービスの終了時に自動的に再起動するように、各サービスのautostart構成要素をtrueに設定しておくことが重要です。proxy-scheme要素には、tcp-acceptorという子要素があり、この子要素には、TCP/IPを介してクライアント接続リクエストを受け入れるために必要なTCP/IP固有の情報がすべて含まれます。acceptor-configも、そのシリアライザ用にConfigurablePofContextを使用するように構成されています。C++ Extendのクライアントでは、シリアライズにPOFを使用する必要があります。

シリアライズとPIF/POFの詳細は、第3章「C++クライアントの統合オブジェクトの構築」を参照してください。

次のように構成されたCoherence*Extendのクラスタ・サービスは、localhostアドレスとport 9099で、受信リクエストをリスニングします。たとえば、dist-extendというCoherenceキャッシュにクライアントが接続しようとすると、Coherence*Extendのクラスタ・サービスがNamedCacheへの後続リクエストを同じ名前で代行します。その名前は、この例ではパーティション・キャッシュとなります。

例4-2 2つのクラスタ・サービスのキャッシュ・コンフィギュレーション

<?xml version="1.0"?>
<!DOCTYPE cache-config SYSTEM "cache-config.dtd">

<cache-config>
  <caching-scheme-mapping>
    <cache-mapping>
      <cache-name>dist-*</cache-name>
      <scheme-name>dist-default</scheme-name>
    </cache-mapping>
  </caching-scheme-mapping>

  <caching-schemes>
    <distributed-scheme>
      <scheme-name>dist-default</scheme-name>
      <lease-granularity>member</lease-granularity>
      <backing-map-scheme>
        <local-scheme/>
      </backing-map-scheme>
      <autostart>true</autostart>
    </distributed-scheme>

    <proxy-scheme>
      <service-name>ExtendTcpProxyService</service-name>
      <thread-count>5</thread-count>
      <acceptor-config>
        <tcp-acceptor>
          <local-address>
            <address>localhost</address>
            <port>9099</port>
          </local-address>
        </tcp-acceptor>
        <serializer>
          <class-name>com.tangosol.io.pof.ConfigurablePofContext</class-name>
        </serializer>
      </acceptor-config>
      <autostart>true</autostart>
    </proxy-scheme>
  </caching-schemes>
</cache-config>

クライアントでのCoherence*Extendの構成

Coherence*Extendのクライアントの構成にある主要な要素はcache-configです。この要素には、キャッシュ・コンフィギュレーションを含むキャッシュ・コンフィギュレーション・ディスクリプタのパスを記述します。このキャッシュ・コンフィギュレーション・ディスクリプタは、DefaultConfigurableCacheFactoryで使用されます。

Coherence*Extendクライアントでは、Coherenceクラスタ内で実行されるCoherence*Extendクラスタ・サービスへの接続およびCoherence*Extendクラスタ・サービスとの通信に、キャッシュ・コンフィギュレーション・ディスクリプタの要素initiator-config内の情報が使用されます。

たとえば、例4-3のキャッシュ・コンフィギュレーション・ディスクリプタは、リモートCoherenceクラスタに接続するキャッシング・スキームを定義します。remote-cache-scheme要素には、tcp-initiatorという子要素があり、この子要素には、リモートCoherenceクラスタ内でCoherence*Extendクラスタ・サービスが実行されているクライアントへの接続に必要なTCP/IP固有の情報がすべて含まれます。

クライアント・アプリケーションで、たとえばdist-extendという名前を使用してCacheFactoryで名前付きキャッシュを取得すると、Coherence*Extendクライアントは(アドレスlocalhostport 9099による)TCP/IPを使用してCoherenceクラスタに接続し、NamedCache実装を返します。この実装は、リモート・クラスタの中で実行している同名のNamedCacheにリクエストをルーティングする機能を持っています。remote-addresses構成要素には、子要素socket-addressを複数記述できます。Coherence*Extendのクライアントは、記載されたアドレスをすべて試すか、またはTCP/IP接続が確立されるまで、アドレスへの接続をランダムに試行します。

例4-3 リモートCoherenceクラスタに接続するキャッシング・スキーム

<?xml version="1.0"?>
<!DOCTYPE cache-config SYSTEM "cache-config.dtd">

<cache-config>
  <caching-scheme-mapping>
    <cache-mapping>
      <cache-name>local-*</cache-name>
      <scheme-name>local-example</scheme-name>
    </cache-mapping>

    <cache-mapping>
      <cache-name>dist-extend</cache-name>
      <scheme-name>extend-dist</scheme-name>
    </cache-mapping>
  </caching-scheme-mapping>

  <caching-schemes>
    <local-scheme>
      <scheme-name>local-example</scheme-name>
    </local-scheme>

    <remote-cache-scheme>
      <scheme-name>extend-dist</scheme-name>
      <service-name>ExtendTcpCacheService</service-name>
      <initiator-config>
        <tcp-initiator>
          <remote-addresses>
            <socket-address>
              <address system-property="tangosol.coherence.proxy.address">localhost</address>
              <port system-property="tangosol.coherence.proxy.port">9099</port>
            </socket-address>
          </remote-addresses>
          <connect-timeout>10s</connect-timeout>
        </tcp-initiator>
        <outgoing-message-handler>
          <request-timeout>5s</request-timeout>
        </outgoing-message-handler>
      </initiator-config>
    </remote-cache-scheme>
  </caching-schemes>
</cache-config>

接続エラーの検出とフェイルオーバー

(ネットワーク、ソフトウェア、ハードウェアなどの障害によって)クライアントとクラスタ間の接続が切断されたことをCoherence*Extendのクライアント・サービスが検出すると、このCoherence*Extendのクライアント・サービスの実装(CacheServiceまたはInvocationService)によって(MemberEventHandlerデリゲートを使用して)MemberEventType.Leftイベントが発生し、このクライアント・サービスは停止します。クライアント・アプリケーションがその後もこのサービスを使用しようとする場合には、サービス自体が自動的に再起動してクラスタへの再接続を試行します。このサービスが接続に成功するとMemberEventType.Joinedイベントが発生し、接続に失敗するとクライアント・アプリケーションに致命的な例外がスローされます。

Coherence*Extendサービスには、接続の切断を検出するためのメカニズムがいくつか用意されています。その中には、(Extend-TCPのTCP/IPのように)基底プロトコルに固有のものもあれば、サービス自体に実装されるものもあります。後者のメカニズムは、outgoing-message-handler構成要素を使用して構成されます。

接続の切断を検出するためにCoherence*Extendのクライアント・サービスで使用される構成可能な主要メカニズムは、リクエストのタイムアウトです。サービスがリモート・クラスタにリクエストを送信したが、リクエストのタイムアウト時間内にレスポンスを受信しなかった場合(<request-timeout>を参照)、サービスでは接続が切断されたと想定されます。Coherence*Extendのクライアント・サービスおよびクラスタ・サービスは、接続を介して定期的にハートビートを送信するように構成することもできます(<heartbeat-interval><heartbeat-timeout>を参照)。構成されたハートビートのタイムアウト時間内にサービスがレスポンスを受信しなかった場合、サービスでは接続が切断されたと想定されます。

Coherence for C++クライアント・ライブラリの構成と使用

C++アプリケーションでCoherence for C++ライブラリを使用するには、そのアプリケーションにCoherence for C++ライブラリをリンクし、Coherence for C++のキャッシュ・コンフィギュレーションと場所を指定する必要があります。

キャッシュ・コンフィギュレーション・ファイルの場所は、サンプル・アプリケーションの項で指定した環境変数、またはプログラム上の処理で設定できます。

環境変数によるコンフィギュレーション・ファイルの場所の設定

「ランタイム・ライブラリと検索パス」の説明にあるように、tangosol.coherence.cacheconfigシステム・プロパティを使用してキャッシュ・コンフィギュレーション・ファイルの場所を指定できます。Windowsでこのコンフィギュレーション・ファイルの場所を設定するには、次のコマンドを実行します。

c:\coherence_cpp\examples> set tangosol.coherence.cacheconfig=config\extend-cache-config.xml

プログラム処理によるコンフィギュレーション・ファイルの場所の設定

DefaultConfigurableCacheFactory::createCacheFactory::configure(必要に応じてCacheFactory::loadXmlFileヘルパー・メソッドを使用)のいずれかを使用して、プログラム処理でコンフィギュレーション・ファイルの場所を設定できます。

例4-4 コンフィギュレーション・ファイルの場所の設定

static Handle coherence::net::DefaultConfigurableCacheFactory::create (String::View vsFile = String::NULL_STRING)

DefaultConfigurableCacheFactoryクラスのcreateメソッドで、新しいCoherence cacheファクトリを作成します。vsFileパラメータで、ロードするCoherenceのコンフィギュレーション・ファイルの名前と場所を指定します。

例4-5 Coherenceキャッシュ・ファクトリの作成

static void coherence::net::CacheFactory::configure (XmlElement::View vXmlCache, XmlElement::View  vXmlCoherence = NULL)

configureメソッドで、CacheFactoryとローカル・メンバーを構成します。cache-config.dtdに対応するXML要素をvXmlCacheパラメータで指定し、coherence.dtdに対応するXML要素をvXmlCoherenceパラメータで指定します。

例4-6 CacheFactoryとローカル・メンバーの構成

static XmlElement::Handle coherence::net::CacheFactory::loadXmlFile (String::View vsFile)

loadXmlFileメソッドで、指定されたファイルからXmlElementを読み取ります。このメソッドでは、CacheFactoryを構成することはできませんが、configureメソッドに対して指定できる構成を取得することはできます。パラメータvsFileで、読込み元であるファイルの名前を指定します。

例4-7のC++コードでは、CacheFactory::configureメソッドを使用して、サーバー/クラスタのキャッシュ・コンフィギュレーション・ファイル(coherence-extend-config.xml)の場所およびC++クライアントのキャッシュ・コンフィギュレーション・ファイル(tangosol-operation-config.xml)の場所を設定します。

例4-7 サーバー/クラスタのキャッシュ・コンフィギュレーション・ファイルの場所の設定

...
// Configure the cache
CacheFactory::configure(CacheFactory::loadXmlFile(String::create("C:\coherence-extend-config.xml")),
         CacheFactory::loadXmlFile(String::create("C:\tangosol-operation-config.xml")));
...

オペレーション・コンフィギュレーション・ファイル(tangosol-coherence-override.xml)

オペレーション・コンフィギュレーション・オーバーライド・ファイル(デフォルトではtangosol-coherence-override.xml)では、Oracle Coherenceで使用する操作設定とランタイム設定を制御して、そのクラスタ・サービス、通信サービスおよびデータ管理サービスを作成、構成および維持します。Javaクライアント同様、C++クライアントでもこのファイルの使用はオプションです。

C++クライアントの場合、このファイルを使用して、具体的にキャッシングに関連していないCoherenceアプリケーションの一般的な操作設定を指定するか、またはオーバーライドできます。C++クライアントの場合の主要な要素は、ロギング、Coherence製品のエディション、および特定のクラスタ・メンバーの場所とロールの割当てのためのものです。

オペレーション・コンフィギュレーションは、プログラム上の処理またはtangosol-coherence-override.xmlファイルで構成できます。プログラム上の処理でオペレーション・コンフィギュレーションを構成するには、CacheFactory::configureメソッド(coherence::net::CacheFactory::configure (View vXmlCache, View vXmlCoherence))のvXmlCoherenceパラメータに次の要素が1つ以上記述され、coherence.dtdに従ったXMLファイルを指定します。

「オペレーション・コンフィギュレーションの要素」では、オペレーション・コンフィギュレーション・ファイルとそこで定義できる要素について詳しく説明しています。

Loggerの構成

Loggerは、オペレーション・コンフィギュレーション・ファイルのlogging-config要素を使用して構成します。この要素では次の属性を指定します。これらの属性では、ログに記録されたエラーに関する詳細情報を記録できます。

例4-9 ログ出力を扱うオペレーション・コンフィギュレーション・ファイル

<coherence>
  <logging-config>
    <destination>stderr</destination>
    <severity-level>5</severity-level>
    <message-format>(thread={thread}): {text}</message-format>
    <character-limit>8192</character-limit>
  </logging-config>
</coherence>

CoherenceのDefaultCacheServerプロキシの起動

すでに説明したクラスタ側のCoherenceキャッシュ・コンフィギュレーションを使用するDefaultCacheServerを起動し、TCP/IPを使用してCoherence for C++クライアントをCoherenceクラスタに接続できるようにするには、次の手順を実行する必要があります。

  1. 現在のディレクトリをOracle Coherenceのライブラリ・ディレクトリに変更します(Windowsの場合は%COHERENCE_HOME%\lib、UNIXの場合は$COHERENCE_HOME/lib)。

  2. Javaコマンドが実行されるようにパスを構成します。

  3. 次のコマンドラインを使用してDefaultCacheServerを起動します。

    例4-10 DefaultCacheServerを起動するコマンドのサンプル

    java -cp coherence.jar -Dtangosol.coherence.cacheconfig=file://<path to the server-side cache configuration descriptor>
         com.tangosol.net.DefaultCacheServer