CTR-Pia
5.4.3
Game Communication Engine
|
PiaSession の名前空間です。 PiaSession はゲーム参加者の集合となるセッション(集まり)の管理を行うセッション管理モジュールです。 [詳細]
構成 | |
class | CommunitySearchCriteria |
コミュニティを検索する際に使用する検索条件の基底クラスです。 [詳細] | |
class | CreateCommunitySetting |
コミュニティの作成処理に関する設定を管理する基底クラスです。 [詳細] | |
class | CreateSessionSetting |
セッションの作成処理に関する設定を管理する基底クラスです。 [詳細] | |
class | ICommunityInfo |
コミュニティの情報へのインターフェースです。 [詳細] | |
class | ICommunityInfoList |
コミュニティの情報へのインターフェースのリストです。 [詳細] | |
class | ISessionInfo |
セッションの情報へのインターフェースです。 [詳細] | |
class | ISessionInfoList |
セッションの情報へのインターフェースのリストです。 [詳細] | |
class | JoinCommunitySetting |
コミュニティの参加処理に関する設定を管理する基底クラスです。 [詳細] | |
class | JoinRandomSessionSetting |
ランダムマッチメイク処理に関する設定を管理する基底クラスです。 [詳細] | |
class | JoinSessionSetting |
セッション参加処理に関する設定を管理する基底クラスです。 [詳細] | |
class | Session |
マッチメイク処理と P2P 通信用セッションの構築/参加処理をまとめるクラスです。 [詳細] | |
class | SessionSearchCriteria |
セッションを検索する際に使用する検索条件の基底クラスです。 [詳細] | |
class | SessionStationInfo |
セッションに参加中のステーション情報です。 [詳細] | |
class | UpdateCommunitySetting |
コミュニティ設定の更新処理に関する設定を管理する基底クラスです。 [詳細] | |
class | UpdateSessionSetting |
セッション設定の更新処理に関する設定を管理する基底クラスです。 [詳細] | |
列挙型 | |
enum | BitRateCheckMode { BitRateCheckMode_Disable = 0, BitRateCheckMode_Enable } |
ビットレート判定機能の設定を行うための列挙型です。 [詳細] | |
enum | NetworkTopology { NetworkTopology_FullMesh = 0, NetworkTopology_RelayMesh } |
Session クラス、Mesh クラスで構築するメッシュのネットワークトポロジーを設定するための列挙型です。 [詳細] | |
関数 | |
モジュールの初期化、終了処理 | |
Result | Initialize () |
PiaSession モジュールを初期化します。 事前に nn::pia::common::Initialize を実行しておく必要があります。 | |
Result | BeginSetup (void) |
セットアップの開始を宣言します。 | |
Result | EndSetup (void) |
セットアップの終了を宣言します。 | |
bool | IsInitialized (void) |
PiaSession モジュールが初期化された状態であるかどうかを返します。 | |
void | Finalize (void) |
PiaSession モジュールを終了します。 nn::pia::common::Finalize を実行する前に実行する必要があります。 | |
変数 | |
static const uint32_t | InvalidSessionId = 0 |
無効な SessionId を示す定数です。 | |
static const int32_t | SessionBroadcastUpdateMeshIntervalDefault = 2000 |
セッション更新情報をブロードキャスト送信できる場合の送信間隔 [msec] のデフォルト値です。 | |
static const uint16_t | SessionDefaultResultSize = 20 |
検索範囲のエントリー数のデフォルト値です。 | |
static const uint32_t | SessionDestroyTimeoutDefault = 5000 |
DestroyMesh 処理のタイムアウト時間 [msec] のデフォルト値です。 | |
static const int32_t | SessionInvalidUplinkBitRateLowerLimit = -1 |
ビットレート判定機能において、無効なビットレート値を表現する定数です。 | |
static const uint32_t | SessionJoinTimeoutDefault = 10000 |
JoinMesh 処理のタイムアウト時間 [msec] のデフォルト値です。 | |
static const int32_t | SessionKeepAliveIntervalDefault = 1000 |
キープアライブの送信間隔 [msec] のデフォルト値です。 | |
static const uint32_t | SessionLeaveTimeoutDefault = 5000 |
LeaveMesh 処理のタイムアウト時間 [msec] のデフォルト値です。 | |
static const uint16_t | SessionMaxRttDefault = 500 |
1つのリレー接続経路の合計 RTT の最大制限値 [msec] のデフォルト値です。 | |
static const int32_t | SessionMaxSilenceTimeDefault = 10000 |
ステーションとの通信が断絶したと判断する無通信時間 [msec] のデフォルト値です。 | |
static const int32_t | SessionMaxSilenceTimeMax = 30000 |
ステーションとの通信が断絶したと判断する無通信時間 [msec] の設定可能な最大値です。 | |
static const int32_t | SessionMaxSilenceTimeMin = 1000 |
ステーションとの通信が断絶したと判断する無通信時間 [msec] の設定可能な最小値です。 | |
static const int32_t | SessionUnicastUpdateMeshIntervalDefault = 5000 |
セッション更新情報のブロードキャスト送信できない場合の送信間隔 [msec] のデフォルト値です。 | |
PiaSession の名前空間です。 PiaSession はゲーム参加者の集合となるセッション(集まり)の管理を行うセッション管理モジュールです。
Session クラス、Mesh クラスで構築するメッシュのネットワークトポロジーを設定するための列挙型です。
今後、Session クラス、Mesh クラスの機能追加に伴って追加する予定です。
Result nn::pia::session::BeginSetup | ( | void | ) |
セットアップの開始を宣言します。
session モジュール以下の初期化処理、すなわち Session::CreateInstance を実行する前に呼び出す必要があります。 別のモジュールのセットアップ処理とバッティングすると正しく動作しませんので セットアップ処理は session::BeginSetup 実行後、session モジュール以下の初期化処理を行い、 速やかに session::EndSetup を実行してセットアップを完了させる必要があります。
ResultNotInitialized session::Initialize が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState セットアップ期間中に再度呼び出しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::session::EndSetup | ( | void | ) |
セットアップの終了を宣言します。
session モジュール以下の初期化処理、すなわち Session::CreateInstance を実行した後に呼び出す必要があります。 このAPI呼び出しにより、session モジュールのシングルトンなどが消費するメモリを確定し、ライブラリ内部でのメモリ管理を最適化します。 別のモジュールのセットアップ処理とバッティングすると正しく動作しませんので セットアップ処理は session::BeginSetup 実行後、session モジュール以下の初期化処理を行い、 速やかに session::EndSetup を実行してセットアップを完了させる必要があります。
ResultNotInitialized session::Initialize が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::session::Finalize | ( | void | ) |
PiaSession モジュールを終了します。 nn::pia::common::Finalize を実行する前に実行する必要があります。
本関数を実行する前に PiaSession モジュールのすべての処理を終了しておく必要があります。 なお、nn::pia::session::Initialize を実行していない状態では何もしません。
Result nn::pia::session::Initialize | ( | ) |
PiaSession モジュールを初期化します。 事前に nn::pia::common::Initialize を実行しておく必要があります。
session モジュールが動的に確保し使用するメモリは nn::pia::common::Initialize で渡したメモリから確保されます。
ResultInvalidState common モジュールが初期化されていない状態です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultAlreadyInitialized 既にこの関数を実行し、初期化が完了している状態です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
bool nn::pia::session::IsInitialized | ( | void | ) |
PiaSession モジュールが初期化された状態であるかどうかを返します。