CTR NEX API Reference
nn::nex::StreamBundling クラス

ストリームごとのパケットバンドリング設定をカプセル化したクラスです。 [詳解]

#include <OnlineCore/src/Transport/Interface/StreamBundling.h>

+ nn::nex::StreamBundling の継承関係図

公開メンバ関数

void Disable ()
 パケットのバンドリングを無効にします。
 
void Enable (TimeInterval tiAutoFlushPeriod=Time(0))
 パケットのバンドリングを有効にします。 [詳解]
 
size_t GetMaxReliableBundlingPackets ()
 Reliableパケットをバンドリングする最大数を取得します。 [詳解]
 
size_t GetMaxUnreliableBundlingPackets ()
 Unreliableパケットをバンドリングする最大数を取得します。 [詳解]
 
qBool IsEnabled () const
 パケットのバンドリングが有効か否かを返します。 [詳解]
 
void SetMaxFlushDelay (TimeInterval ti)
 パケットのバンドリングタイムアウト時間を指定します。 [詳解]
 
void SetMaxReliableBundlingPackets (size_t packets)
 Reliableパケットをバンドリングする最大数を設定します。 [詳解]
 
void SetMaxUnreliableBundlingPackets (size_t packets)
 Unreliableパケットをバンドリングする最大数を設定します。 [詳解]
 

詳解

ストリームごとのパケットバンドリング設定をカプセル化したクラスです。

Stream::GetSettings().GetBundling()のメソッド呼び出しによって、 そのストリームに関連付けられた、 本クラスのオブジェクトへの参照が得られます。このオブジェクトを利用して、 ストリーム設定にアクセスすることができます。

規定値は、有効で、タイムアウト時間は0で、Dispatchごとにバンドリングされて送信されます。

Stream::GetSettings()で取得したストリームに対しては、DOやDirectStreamなどすべてのパケットのバンドリング設定となります。

参照
StreamSettings

関数詳解

qBool nn::nex::StreamBundling::IsEnabled ( ) const

パケットのバンドリングが有効か否かを返します。

デフォルトは有効です。

戻り値
有効フラグ
void nn::nex::StreamBundling::Enable ( TimeInterval  tiAutoFlushPeriod = Time(0))

パケットのバンドリングを有効にします。

指定された時間まで、パケットをバッファリングしてからバンドリングします。 規定値は、有効かつタイムアウト時間は、0です。

引数
[in]tiAutoFlushPeriodタイムアウト時間 [msec] 規定値は0で、その時点でキューに溜まっているパケットをバンドリングして、バンドリングのためにバッファリングを行いません。
void nn::nex::StreamBundling::SetMaxFlushDelay ( TimeInterval  ti)

パケットのバンドリングタイムアウト時間を指定します。

指定された時間パケットをバッファリングしてからバンドリングします。

引数
[in]tiタイムアウト時間 [msec]

0は、その時点でキューに溜まっているパケットをバンドリングして、バンドリングのためにバッファリングを行いません。

size_t nn::nex::StreamBundling::GetMaxUnreliableBundlingPackets ( )

Unreliableパケットをバンドリングする最大数を取得します。

戻り値
最大バンドリングパケット数
void nn::nex::StreamBundling::SetMaxUnreliableBundlingPackets ( size_t  packets)

Unreliableパケットをバンドリングする最大数を設定します。

引数
[in]packets最大バンドリングパケット数 0は、バンドリングせずに送信します。  初期値は、std::numeric_limits<size_t>::max() です。
size_t nn::nex::StreamBundling::GetMaxReliableBundlingPackets ( )

Reliableパケットをバンドリングする最大数を取得します。

戻り値
最大バンドリングパケット数
void nn::nex::StreamBundling::SetMaxReliableBundlingPackets ( size_t  packets)

Reliableパケットをバンドリングする最大数を設定します。

ACKもReliableパケットの扱いとなります。

引数
[in]packets最大バンドリングパケット数 0は、バンドリングせずに送信します。  初期値は、std::numeric_limits<size_t>::max() です。