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

PiaTransport の名前空間です。 PiaTransport は様々な送受信機能を提供するトランスポート管理モジュールです。PiaSession と組み合わせて使用します。 [詳細]

構成

struct  ConnectionAnalysisData
 ConnectionAnalysisData は、接続品質に関係するパラメータ(RTT、パケロス率)をまとめた構造体です。 [詳細]
 
class  NetworkFactory
 ネットワークに必要なクラスを生成するためのインタフェースです(ファクトリパターン)。 [詳細]
 
struct  PacketAnalysisData
 PacketAnalysisData は、送受信されるパケットの内部データを解析した結果を集計するために用意された構造体です。 [詳細]
 
class  Protocol
 プロトコルの基底クラスです。 [詳細]
 
class  ReliableBroadcastProtocol
 大きなデータを全員に一斉送信するプロトコルです。 [詳細]
 
class  ReliableProtocol
 到達保証された通信を行うプロトコルです。 [詳細]
 
class  RoundRobinUnreliableProtocol
 UnreliableProtocol を継承し、負荷を分散しながら送信する機能を追加したクラスです。 [詳細]
 
class  SequenceIdController
 パケットのシーケンス ID を管理します。 それに伴い、パケットロスをプロファイリングする機能も持ちます。 [詳細]
 
class  Station
 ステーションを表現するクラスです。ステーションとは、 Pia のセッションに参加しているマシンを指す言葉です。 [詳細]
 
class  StationConnectionInfo
 ステーションを一意に識別するためのアドレスです。 [詳細]
 
class  StationLocation
 ステーションを一意に識別するためのアドレスです。 [詳細]
 
class  StationManager
 複数の Station インスタンスを統括するクラスです。 [詳細]
 
class  ThreadStreamManager
 送受信スレッドを統括するクラスです。 [詳細]
 
class  Transport
 transport モジュールの中核的な存在のクラスです。 [詳細]
 
struct  TransportAnalysisData
 TransportAnalysisData は、送受信パケットの分析データと、 各ステーションとの接続品質を表すパラメータ(RTT、パケロス率)をまとめた構造体です。 [詳細]
 
class  TransportAnalyzer
 TransportAnalyzer クラスは、パケット解析結果や RTT 、パケロス率などを 報告するために用意されたクラスです。 [詳細]
 
class  UnreliableProtocol
 信頼性の無い(データ欠落の可能性がある)プロトコルのクラスです。 UnreliableProtocol は、データ到着の順序を保証しません。 送信側がデータを Send() した順で受信側がデータを Receive() できるとは限りません。 [詳細]
 

関数

Result BeginSetup (void)
 セットアップの開始を宣言します。
 
Result EndSetup (void)
 セットアップの終了を宣言します。
 
void Finalize (void)
 transport モジュールを終了します。 Initialize() を呼び出していない状態でこの関数を呼び出した場合は、 何もせずに返ります。
 
Result Initialize (void)
 transport モジュールを初期化します。
 
bool IsInitialized (void)
 transport モジュールが初期化された状態であるかどうかを返します。
 

説明

PiaTransport の名前空間です。 PiaTransport は様々な送受信機能を提供するトランスポート管理モジュールです。PiaSession と組み合わせて使用します。

関数

Result nn::pia::transport::BeginSetup ( void  )

セットアップの開始を宣言します。

transport モジュールのシングルトンなどを作成する前に呼ぶ必要があります。 アプリケーションが transport モジュールのシングルトンを一つも作成しない場合であっても、 この関数と EndSetup は必ず呼び出す必要があります。

戻り値
この関数を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

ResultNotInitialized transport::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

参照
EndSetup
Result nn::pia::transport::EndSetup ( void  )

セットアップの終了を宣言します。

transport モジュールのシングルトンなどを作成し終えた後に呼ぶ必要があります。 この関数呼び出しにより、 transport モジュールのシングルトンなどが消費する メモリを確定し、ライブラリ内部でのメモリ管理を最適化します。 アプリケーションが transport モジュールのシングルトンを一つも作成しない場合であっても、 BeginSetup とこの関数は必ず呼び出す必要があります。

戻り値
この関数を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

ResultNotInitialized transport::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

参照
BeginSetup
void nn::pia::transport::Finalize ( void  )

transport モジュールを終了します。 Initialize() を呼び出していない状態でこの関数を呼び出した場合は、 何もせずに返ります。

参照
IsInitialized, Initialize
Result nn::pia::transport::Initialize ( void  )

transport モジュールを初期化します。

戻り値
無事に初期化が完了すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:
ResultAlreadyInitialized 既に初期化は終了しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
参照
IsInitialized, Finalize
bool nn::pia::transport::IsInitialized ( void  )

transport モジュールが初期化された状態であるかどうかを返します。

この関数はスレッドセーフです。

戻り値
transport モジュールが初期化されていれば true 、されていなければ false が返されます。
参照
Initialize, Finalize