public interface LocalServiceBase
Local Service とは RT-Middlewareのマネージャデーモン内で各種サービ スを提供するための仕組みである。Local Serviceにはいくつかのユース ケースが考えられる。 1. RTCの内部ロジックに対してサービスを提供する。コンポーネントの開 発者は、一定の艇順を経て、Local Serviceのインスタンスへの参照を得 て、このサービスを利用することができる。 2. マネージャ等に機能を追加するためのサービス。たとえは、RTCの名前 を登録するCORBAネームサービスの代わりに、新たなディレクトリサービ スやブロードキャストによる名前通知機能などを新たな機能をマネージャ に追加するために利用することができる。マネージャには、様々なアクショ ンに対するフックが用意されており、これを利用することで、マネージャ の様々なイベントに対してアクションを起こすことができる。 3. マネージャは自身のサービス以外に付加的に外部に対してサービスを 提供する機能を有する。外部からCORBA経由で、ローカルの機能、たとえ ばデバイスやリソースのマネジメント機能に対してアクセスする方法を提 供する。サービスのインスタンス化後に、マネージャに対して、マネージャ サービスとして登録することで、外部からのアクセスを受け付けることが できるようになる。 Local Service はモジュールとしてロードされ、通常唯一のインスタンス が生成される。すなわち、LocalService はシングルトンとして実装され る。インスタンス化されたサービスはサービスリストに登録され、RTC等 からは名前やUUIDによってインスタンスの参照を入手することができる。 このオブジェクトのライフサイクルは以下の通り。 -# オブジェクトは通常、共有オブジェクト (so, DLL) としてコンパイル・ リンクされる。 -# マネージャに対してロードされるとモジュール初期化関数によりオブ ジェクトファクトリが、LocalServiceFactory に対して登録される。 登録のキーにはUUIDと名前が利用され、これによりサービスが区別さ れる。 -# rtc.conf等のコンフィギュレーション指定により、有効化することが 指定されているサービスインプロバイダは、RTCの起動と同時にインス タンス化される。 -# インスタンス化後、初期化関数 init() が呼ばれる。引数には当該サー ビスのためのコンフィギュレーションオプションが coil::Propertyに より渡される。 -# マネージャサービスオペレーション reinit が呼ばれると、すべての Local Service お reinit が呼び出され、更新されたコンフィギュレー ション情報が読み込まれる。 -# マネージャ解体時には、すべての Local Service の finalizeが呼び 出され、解体されるので、ここでリソースの解放など終了処理を行 う。 このクラスの実装に当たっては、少なくとも以下の純粋仮想関数を実装す る必要がある。 - init(): 初期化関数。与えられた RTObject および ServiceProfile か ら、当該オブジェクトを初期化する。 - reinit(): 再初期化関数。ServiceProfile は設定情報更新のため同一 IDで呼び出されることが有るが、その際にこの関数が新たな ServiceProfile とともに呼び出される。関数内では、設定の変更など 再初期化処理を実装する。 - getProfile(): 設定されたプロファイルを返す関数。 - finalize(): 終了処理。コンシューマがデタッチされる際に呼び出され る関数。関数内では終了処理を実装する。 LocalService は通常共有オブジェクトとしてコンパイル・リンク される。共有オブジェクトのエントリポイントは通常コンパイルされたファ イル名の basename + "Init" にしておく。以下に、クラス名、ファイル 名、エントリポイント関数名の推奨例を示す。 - 実装クラス名: MyLocalService - ファイル名: MyLocalService.h. MyLocalService.cpp - 共有オブジェクト名: MyLocalService.so (or DLL) - エントリポイント関数名: MyLocalServiceInit() エントリポイント関数は通常以下のように、LocalServiceFactory に当該コンシューマのファクトリ (と解体ファンクタ) を登録する以下の ような関数になる。
extern "C"
{
void MyLocalServiceInit()
{
RTC::LocalServiceFactory& factory
= RTC::LocalServiceFactory::instance();
factory.addFactory(::RTC::MyLocalSerivce::name,
::coil::Creator< ::RTC::LocalServiceBase,
::RTC::MyLocalService>,
::coil::Destructor< ::RTC::LocalServiceBase,
::RTC::MyLocalService>);
}
};
| 修飾子とタイプ | メソッドと説明 |
|---|---|
void |
_finalize()
終了処理
{@.ja LocalService が終了する際に呼び出される終了処理用関数。
|
LocalServiceProfile |
getProfile()
LocalServiceProfile を返す
{@.ja init()/reinit()で与えられた LocalServiceProfile は通常オブジェク
ト内で保持される。
|
boolean |
init(Properties props)
LocalServiceクラスの初期化関数
{@.ja このオブジェクトの初期化を行う。
|
boolean |
reinit(Properties props)
LocalServiceクラスの再初期化関数
|
boolean init(Properties props)
このオブジェクトの初期化を行う。LocalService を実装する場合、外 部からの設定情報は、このinit()関数により与えられる。
props - 外部から与えられた Propertiesboolean reinit(Properties props)
props - 新たに与えられた PropertiesLocalServiceProfile getProfile()
init()/reinit()で与えられた LocalServiceProfile は通常オブジェク ト内で保持される。この関数では保持されている ServiceProfile を返 す。
void _finalize()
LocalService が終了する際に呼び出される終了処理用関数。当該オブ ジェクトが保持するリソースを解放するなどの処理を行う。