クラス Sapie::CControllerBase

制御クラスの基底クラス。 [詳細]

#include <ControllerBase.h>

Sapie::CControllerBaseに対する継承グラフ


Public メソッド
	CControllerBase ()
	コンストラクタ
virtual	~CControllerBase ()
	デストラクタ
long	GetErrorCode ()
	エラーコードを取得する
long	RefAsyncRequest (long lReqIdNo, AsyncReqInfo *info)
	非同期要求を参照する。
void	SetEventDispatcher (CEventDispatcher *evDispatcher)
	イベントディスパッチャを登録する。
CEventDispatcher *	GetEventDispatcher ()
	イベントディスパッチャ取得
Protected メソッド
void	SetErrorCode (long errCode)
	エラーコードを設定する
long	RegisterAsyncRequest ()
	非同期要求登録
void	UnregisterAsyncRequest (long lReqNo)
	非同期要求削除
long	SendEvent (EventType type, long lReqIdNo, long lResult, CEventParam *evParam)
	イベント発生

説明

制御クラスの基底クラス。

すべての制御クラスに必要な機能を提供するための既定クラスである。非同期要求の管理用メソッドや、イベントの制御機構の基礎部分を提供する。

関数

long Sapie::CControllerBase::GetErrorCode ( )

エラーコードを取得する

制御クラスが直前に行った操作のエラーコードを取得する。

戻り値:: errCode エラーコード

long Sapie::CControllerBase::RefAsyncRequest	(	long	lReqIdNo,
		AsyncReqInfo *	info
	)

非同期要求を参照する。

要求識別番号をキーとして、その番号を持つ要求が存在するかどうか、存在する場合に、それがどのような要求かという情報を取得する。

引数:

`[in]`	lReqIdNo	参照する非同期要求の要求識別番号
`[out]`	info	非同期要求の内容

戻り値:

非同期要求が参照できたかどうか。

0: 非同期要求が参照できなかった。
0以外: 非同期要求が参照できた。

void Sapie::CControllerBase::SetEventDispatcher ( CEventDispatcher * evDispatcher )

イベントディスパッチャを登録する。

この制御クラスで発生したイベントは、このメソッドで登録されたイベントディスパッチャによってアプリに通知される。

イベントを返すことがある制御クラスには、必ずこのメソッドを用いてイベントディスパッチャを登録する必要がある。イベントディスパッチャの登録されていない制御クラスでイベントが発生した場合は、そのイベントは破棄される。

既にイベントディスパッチャが登録されている場合に本メソッドをコールした場合は設定は上書きされる。

引数:

[in] evDispatcher 登録するイベントディスパッチャのポインタ

CEventDispatcher* Sapie::CControllerBase::GetEventDispatcher ( )

イベントディスパッチャ取得

戻り値:: 登録されているイベントディスパッチャのポインタ

void Sapie::CControllerBase::SetErrorCode ( long errCode ) [protected]

エラーコードを設定する

同期要求の実行時、非同期要求の開始時に発生したエラーのエラーコードを設定する。すべての同期要求／非同期要求の提供メソッドは、この関数を1度はコールし、結果を設定しなければならない。処理が成功した場合には0を設定する。

引数:

[in] errCode エラーコード

long Sapie::CControllerBase::RegisterAsyncRequest ( ) [protected]

非同期要求登録

非同期要求を開始することを宣言する。要求識別番号を採番する。非同期要求を提供するメソッドは、このメソッドをコールして要求識別番号を受け取り、それを呼出側へ通知すること。

戻り値:: 新たに採番された要求識別番号。

void Sapie::CControllerBase::UnregisterAsyncRequest ( long lReqNo ) [protected]

非同期要求削除

非同期要求を終了する。指定した非同期要求の情報は削除される。

引数:

[in] lReqNo 終了する非同期要求の要求識別番号。

long Sapie::CControllerBase::SendEvent	(	EventType	type,
		long	lReqIdNo,
		long	lResult,
		CEventParam *	evParam
	)			`[protected]`

イベント発生

Sapie::CEventInfo 構造体が生成され、登録されているイベントディスパッチャへ通知される。

引数:

`[in]`	type	イベント種別。
`[in]`	lReqIdNo	非同期要求に紐付けれたイベントの場合は要求識別番号。紐付けられないイベントの場合は0を指定する。
`[in]`	lResult	結果（エラーコード）。正常時は0、異常時は0以外を指定する。
`[in]`	evParam	イベントパラメータ。イベントパラメータが存在しない場合は NULL を指定する。イベントパラメータの型はイベント種別に対して一意でなければならない。

戻り値:

イベントIDまたは、イベントの受付状況を返す。

1以上：イベントIDを示す。イベントは遅れてアプリへ通知される。イベント処理が完了した時点で各コントローラクラスへイベントで通知される。
0: 関数の完了時点でイベント処理がすべて完了していることを表す。
-1以下: 何らかの原因でアプリへのイベント通知が行われなかったことを表す。

このクラスの説明は次のファイルから生成されました:

ControllerBase.h

クラス Sapie::CControllerBase

Public メソッド

Protected メソッド

説明

関数