LocalService　基底クラス [詳解]

OpenRTM_aist.LocalServiceBase.LocalServiceBase の継承関係図

公開メンバ関数
def	init (self, props)
	LocalServiceクラスの初期化関数 [詳解]

def	reinit (self, props)
	LocalServiceクラスの再初期化関数 [詳解]

def	getProfile (self)
	LocalServiceProfile を返す [詳解]

def	finalize (self)
	終了処理 [詳解]

詳解

LocalService　基底クラス

Local Service とは RT-Middlewareのマネージャデーモン内で各種サービスを提供するための仕組みである。Local Serviceにはいくつかのユースケースが考えられる。

RTCの内部ロジックに対してサービスを提供する。コンポーネントの開発者は、一定の艇順を経て、Local Serviceのインスタンスへの参照を得て、このサービスを利用することができる。
マネージャ等に機能を追加するためのサービス。たとえは、RTCの名前を登録するCORBAネームサービスの代わりに、新たなディレクトリサービスやブロードキャストによる名前通知機能などを新たな機能をマネージャに追加するために利用することができる。マネージャには、様々なアクションに対するフックが用意されており、これを利用することで、マネージャの様々なイベントに対してアクションを起こすことができる。
マネージャは自身のサービス以外に付加的に外部に対してサービスを提供する機能を有する。外部から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>);
   }
 };

メソッド詳解

def OpenRTM_aist.LocalServiceBase.LocalServiceBase.finalize ( self )

終了処理

LocalService が終了する際に呼び出される終了処理用関数。当該オブジェクトが保持するリソースを解放するなどの処理を行う。

virtual void finalize() = 0;

def OpenRTM_aist.LocalServiceBase.LocalServiceBase.getProfile ( self )

LocalServiceProfile を返す

init()/reinit()で与えられた LocalServiceProfile は通常オブジェクト内で保持される。この関数では保持されている ServiceProfile を返す。

戻り値: このオブジェクトが保持している LocalServiceProfile

virtual const LocalServiceProfile& getProfile() const = 0;

def OpenRTM_aist.LocalServiceBase.LocalServiceBase.init	(	self,
		props
	)

LocalServiceクラスの初期化関数

このオブジェクトの初期化を行う。LocalService を実装する場合、外部からの設定情報は、このinit()関数により与えられる。

引数

profile 外部から与えられた LocalServiceProfile

戻り値: 与えられた LocalServiceProfile が不正の場合 false

virtual bool init(const coil::Properties& props) = 0;

def OpenRTM_aist.LocalServiceBase.LocalServiceBase.reinit	(	self,
		props
	)

LocalServiceクラスの再初期化関数

TODO: ドキュメント作成

引数

profile 新たに与えられた LocalServiceProfile

戻り値: 不正な LocalServiceProfile が与えられた場合は false

virtual bool reinit(const coil::Properties& props) = 0;

このクラス詳解は次のファイルから抽出されました:

/tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/LocalServiceBase.py

公開メンバ関数

詳解

メソッド詳解