MGL::Event::Notifier クラス

MGL イベント通知 [詳解]

#include <mgl_event_notifier.h>

MGL::Event::Notifier の継承関係図

公開メンバ関数
	Notifier () noexcept
	コンストラクタ
bool	Register (Handle &handle, NotifyType type, CallbackFunction callback, void *callbackArg=nullptr) noexcept
	イベント通知の登録
void	Unregister (Handle &handle) noexcept
	イベント通知の登録解除
bool	Notify (NotifyType type, void *notifyArg=nullptr) noexcept
	イベント通知の実行
基底クラス MGL::SharedSingleton< Notifier > に属する継承公開メンバ関数
	SharedSingleton (const SharedSingleton &) noexcept=delete
	SharedSingleton (SharedSingleton &&) noexcept=delete
SharedSingleton &	operator= (const SharedSingleton &) noexcept=delete
SharedSingleton &	operator= (SharedSingleton &&) noexcept=delete

静的公開メンバ関数
static STL::unique_ptr< Notifier > &	GetInstanceRef () noexcept
	インスタンスの取得
基底クラス MGL::SharedSingleton< Notifier > に属する継承静的公開メンバ関数
static Notifier &	CreateInstance (Args... args) noexcept
	インスタンスの生成
static Notifier &	GetInstance () noexcept
	インスタンスの取得
static void	DestroyInstance () noexcept
	インスタンスの破棄
static bool	HasInstance () noexcept
	有効なインスタンスを保持しているかを取得

詳解

MGL イベント通知

関数詳解

GetInstanceRef()

STL::unique_ptr< Notifier > & MGL::Event::Notifier::GetInstanceRef ( )

staticnoexcept

インスタンスの取得

戻り値

インスタンスの参照

Notify()

bool MGL::Event::Notifier::Notify ( NotifyType type, void * notifyArg = nullptr )

noexcept

イベント通知の実行

引数

[in]	type	通知タイプ
[in]	notifyArg	通知の引数（コールバック関数のnotifyArgに送られる）

戻り値

true	成功
false	失敗

覚え書き

同じ通知タイプのイベントを多重に呼ぶことはできず，その場合は失敗となる．

Register()

bool MGL::Event::Notifier::Register ( Handle & handle, NotifyType type, CallbackFunction callback, void * callbackArg = nullptr )

noexcept

イベント通知の登録

引数

[in,out]	handle	登録したハンドルの格納先
[in]	type	通知タイプ
[in]	callback	コールバック関数
[in]	callbackArg	コールバック関数の引数

戻り値

true	成功
false	失敗

Unregister()

void MGL::Event::Notifier::Unregister ( Handle & handle )

noexcept

イベント通知の登録解除

引数

[in,out]

handle

登録を解除するハンドル

---

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

• /Users/acerola/x/mgl/include/mgl/event/mgl_event_notifier.h
• /Users/acerola/x/mgl/src/event/mgl_event_notifier.cc