CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
クラス nn::pia::common::WatermarkManager

Watermark インスタンス群を管理するクラスです(サポート対象外)。 [詳細]

+ nn::pia::common::WatermarkManagerに対する継承グラフ

Public メソッド

void DisableAllWatermark (void)
 WatermarkManager が管理する、全 Watermark インスタンスの Update() 機能を無効にします。
 
void EnableAllWatermark (void)
 WatermarkManager が管理する、全 Watermark インスタンスの Update() 機能を有効にします。
 
WatermarkGetWatermark (int key)
 Watermark インスタンスを得ます(非 const 版)
 
const WatermarkGetWatermark (int key) const
 Watermark インスタンスを得ます( const 版)
 
virtual void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 

Static Public メソッド

static Result CreateInstance (void)
 common モジュールにおけるクラスのインスタンスを作成します(シングルトンパターン)。
 
static void DestroyInstance (void)
 common モジュールにおけるクラスのインスタンスを破棄します(シングルトンパターン)。
 
static WatermarkManagerGetInstance (void)
 common モジュールにおけるクラスのインスタンスを得ます(シングルトンパターン)
 

Static Public 変数

static const int KeyReceivethreadstreamBufferNum = 1
 受信スレッドにおける内部バッファの使用量に対応するキーです。
 
static const int KeyReliableProtocolReceiveBufferNum = 4
 ReliableProtocol の受信バッファ使用量に対応するキー。
 
static const int KeyReliableProtocolSendBufferNum = 3
 ReliableProtocol の送信バッファ使用量に対応するキー。
 
static const int KeySendthreadstreamBufferNum = 0
 送信スレッドにおける内部バッファの使用量に対応するキーです。
 
static const int KeySessionProtocolReliableReceiveBufferNum = 8
 SessionProtocol の Reliable 受信バッファ使用量に対応するキー。
 
static const int KeySessionProtocolReliableSendBufferNum = 7
 SessionProtocol の Reliable 送信バッファ使用量に対応するキー。
 
static const int KeyStationProtocolReliableReceiveBufferNum = 6
 StationProtocolReliable の受信バッファ使用量に対応するキー。
 
static const int KeyStationProtocolReliableSendBufferNum = 5
 StationProtocolReliable の送信バッファ使用量に対応するキー。
 
static const int KeyUnreliableProtocolReceiveBufferNum = 9
 UnreliableProtocol の受信バッファ使用量に対応するキー。
 
static const int WatermarkInstances = 10
 WatermarkManager が管理する Watermark インスタンスの最大個数。
 

説明

Watermark インスタンス群を管理するクラスです(サポート対象外)。

WatermarkManager クラスは、 Watermark インスタンス群を管理するために用意されたクラスです。 Pia 内部バッファ使用量のピーク値などを取得することができます。

関数

static Result nn::pia::common::WatermarkManager::CreateInstance ( void  )
static

common モジュールにおけるクラスのインスタンスを作成します(シングルトンパターン)。

戻り値
インスタンスの作成に成功すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

ResultNotInitialized common モジュールが未初期化です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState CreateInstance() を呼ぶタイミングが誤っています。 BeginSetup()EndSetup() 間で呼び出す必要があります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultAlreadyExists 既にインスタンスは作成されています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

void nn::pia::common::WatermarkManager::DisableAllWatermark ( void  )

WatermarkManager が管理する、全 Watermark インスタンスの Update() 機能を無効にします。

参照
EnableAllWatermark
void nn::pia::common::WatermarkManager::EnableAllWatermark ( void  )

WatermarkManager が管理する、全 Watermark インスタンスの Update() 機能を有効にします。

参照
DisableAllWatermark
static WatermarkManager* nn::pia::common::WatermarkManager::GetInstance ( void  )
inlinestatic

common モジュールにおけるクラスのインスタンスを得ます(シングルトンパターン)

事前に CreateInstance() によってインスタンスを作成していない場合は、 NULLポインタが返されます。

戻り値
インスタンスへのポインタ。
Watermark* nn::pia::common::WatermarkManager::GetWatermark ( int  key)

Watermark インスタンスを得ます(非 const 版)

引数
[in]keyキーを指定します。 0 <= key <= KeyMax でなくてはなりません。 範囲外のキーを指定した場合はアサート停止します。
戻り値
成功すれば Watermark インスタンスへのポインタが、失敗すれば NULL ポインタが返されます。
const Watermark* nn::pia::common::WatermarkManager::GetWatermark ( int  key) const

Watermark インスタンスを得ます( const 版)

引数
[in]keyキーを指定します。 0 <= key <= KeyMax でなくてはなりません。 範囲外のキーを指定した場合はアサート停止します。
戻り値
成功すれば Watermark インスタンスへのポインタが、失敗すれば NULL ポインタが返されます。
virtual void nn::pia::common::WatermarkManager::Trace ( uint64_t  flag) const
virtual

デバッグに有用な情報をプリントします。

引数
[in]flagトレースフラグの論理和。詳細はTraceFlag 型を参照してください。