CTR-Pia
5.4.3
Game Communication Engine
|
PiaInet の名前空間です。 PiaInet は、インターネット通信に対応するネットワーク管理モジュールです。PiaSession と一緒に使用します。 [詳細]
構成 | |
struct | DebugSetting |
(デバッグ用) inet::SetDebugSetting に渡すデバッグ機能設定用構造体です。 [詳細] | |
class | NexCommunitySearchCriteriaCommunityId |
コミュニティ ID をコミュニティの検索条件に指定するクラスです。 [詳細] | |
class | NexCommunitySearchCriteriaOfficial |
公式コミュニティを検索する際に使用する検索条件のクラスです。 [詳細] | |
class | NexCommunitySearchCriteriaOwner |
コミュニティのオーナーをコミュニティの検索条件に指定するクラスです。 [詳細] | |
class | NexCommunitySearchCriteriaParticipant |
プリンシパル ID をコミュニティの検索条件に指定するクラスです。 [詳細] | |
class | NexCreateCommunitySetting |
コミュニティ作成処理に関する設定を管理するクラスです。 [詳細] | |
class | NexCreateSessionSetting |
セッション構築処理に関する設定を管理するクラスです。 [詳細] | |
class | NexDebugSession |
(デバッグ用)デバッグ用ダミーセッションを扱うクラスです。(製品版には含まれません) [詳細] | |
class | NexFacade |
NEX ライブラリのファサード(facade、インターフェースラッパー)クラスです。 [詳細] | |
class | NexJoinCommunitySetting |
コミュニティ参加処理に関する設定を管理するクラスです。 [詳細] | |
class | NexJoinRandomSessionSetting |
ランダムマッチメイク処理に関する設定を管理するクラスです。 [詳細] | |
class | NexJoinSessionSetting |
セッション参加処理に関する設定を管理するクラスです。 [詳細] | |
class | NexNetworkFactory |
NEX ライブラリ(インターネット通信)を利用したネットワークに必要なクラスを生成するためのクラスです(ファクトリパターン)。 [詳細] | |
class | NexSessionInfo |
インターネット通信のセッション情報クラスです。 [詳細] | |
class | NexSessionSearchCriteria |
セッションを検索する際に使用する検索条件のクラスです。 [詳細] | |
class | NexSessionSearchCriteriaOwner |
マッチメイクセッションのオーナー(通常はセッションホストと同じ)を検索条件に指定するクラスです。 [詳細] | |
class | NexSessionSearchCriteriaParticipant |
プリンシパル ID をセッションの検索条件として指定するクラスです。 [詳細] | |
class | NexSessionSearchCriteriaSessionId |
セッション ID を検索条件に指定するクラスです。 [詳細] | |
struct | NexSessionStartupSetting |
nn::pia::session::Session::Startup に渡す設定用構造体です。 [詳細] | |
class | NexUpdateCommunitySetting |
コミュニティ設定の更新処理に関する情報を管理するクラスです。 [詳細] | |
class | NexUpdateSessionSetting |
セッション設定の更新処理に関する情報を管理するクラスです。 [詳細] | |
列挙型 | |
enum | SelectionMethod { SelectionMethod_Random = 0, SelectionMethod_BroadenRangeWithSelectionPriority, SelectionMethod_ScoreBased } |
ランダムマッチメイク実行時に参加するセッションの選択方法を表す列挙型です。 [詳細] | |
enum | SessionType { SessionType_Anybody = 0, SessionType_Friend } |
セッションタイプを表す列挙型です。 [詳細] | |
関数 | |
Result | BeginSetup (void) |
セットアップの開始を宣言します。 | |
Result | EndSetup (void) |
セットアップの終了を宣言します。 | |
void | Finalize (void) |
inetモジュールを終了します。 | |
Result | Initialize () |
inet モジュールを初期化します。 | |
bool | IsInitialized (void) |
inet モジュールが初期化された状態であるかどうかを返します。 | |
Result | SetDebugSetting (const DebugSetting &debugSetting) |
(デバッグ用) inet のデバッグ用機能について設定します。 | |
変数 | |
const uint32_t | ApplicationDataBufferSizeMax = 512 |
アプリケーション定義のデータとして設定できる最大サイズ | |
const uint32_t | AttributeArraySizeMax = 100 |
検索条件に指定できる属性値の配列の最大長 | |
const uint32_t | AttributeSizeMax = 6 |
セッションに指定可能な属性の数 | |
const uint32_t | CommunityInfoListSizeMax = 100 |
検索可能なコミュニティ数の最大長 | |
const uint32_t | DefaultMtuSize = 1240 |
MTUのデフォルト定数です。 | |
const int | DefaultRttInitialPulseInterval = 200 |
初期段階での RTT 計測パルス送信間隔のデフォルト値です。単位はミリ秒です。 | |
const uint32_t | DescriptionLengthMax = 256 |
セッションに設定できる説明文字列の最大長 | |
const uint32_t | MtuSizeMax = 1364 |
MTUの上限定数です。 | |
const uint32_t | MtuSizeMin = 576 |
MTUの下限定数です。 | |
const uint32_t | ParticipantArraySizeMax = 100 |
検索条件に指定できるユーザーのプリンシパル ID の配列の最大長 | |
const uint32_t | PrincipalIdArraySizeMax = 100 |
ブロックリスト管理に指定可能なユーザーのプリンシパル ID の配列の最大長 | |
const uint8_t | SearchCriteriaListSizeMax = 2 |
ランダムマッチメイク時に設定できる検索条件の最大数 | |
const uint32_t | SessionBroadenRangeAttributeIndex = nn::nex::MATCHMAKE_SESSION_BROADEN_RANGE_ATTRIBUTE_INDEX |
レンジ拡大形式でセッションを選ぶ際の基準とする属性値のインデックス | |
const uint32_t | SessionInfoListSizeMax = 300 |
検索可能なセッション数の最大長 | |
const uint32_t | SessionMatchmakeKeywordLength = 32 |
あいことばマッチメイク時に設定できるあいことばの文字列長 | |
const uint8_t | SessionSelectionPriorityMax = nn::nex::MAX_PROGRESS_SCORE |
設定可能なゲーム進行度の最大値 | |
const uint32_t | SessionSystemPasswordLengthMax = nn::nex::MATCHMAKE_SESSION_SYSTEM_PASSWORD_LENGTH |
システムパスワードの文字列長 | |
const uint32_t | SessionUpdateSelectionPriorityIntervalTimeMin = nn::nex::UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME |
ゲーム進行度の最小アップデート間隔 | |
const uint32_t | SessionUserPasswordLengthMax = nn::nex::MAX_MATCHMAKE_SESSION_USER_PASSWORD_LENGTH |
ユーザーパスワードの文字列長 | |
PiaInet の名前空間です。 PiaInet は、インターネット通信に対応するネットワーク管理モジュールです。PiaSession と一緒に使用します。
Result nn::pia::inet::BeginSetup | ( | void | ) |
セットアップの開始を宣言します。
inetモジュールのシングルトンなどを作成する前に呼び出す必要があります。 アプリケーションが inet モジュールのシングルトンを一つも作成しない場合であっても、 このAPIと EndSetup は必ず呼び出す必要があります。
ResultNotInitialized inet モジュールの初期化関数が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::EndSetup | ( | void | ) |
セットアップの終了を宣言します。
inet モジュールのシングルトンなどを作成し終えた後に呼美出す必要があります。 この API 呼び出しにより、inet モジュールのシングルトンなどが消費する メモリを確定し、ライブラリ内部でのメモリ管理を最適化します。 アプリケーションが inet モジュールのシングルトンを一つも作成しない場合であっても、 BeginSetup とこの API は必ず呼び出す必要があります。
ResultNotInitialized inet モジュールの初期化関数が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::Initialize | ( | ) |
inet モジュールを初期化します。
bool nn::pia::inet::IsInitialized | ( | void | ) |
inet モジュールが初期化された状態であるかどうかを返します。
Result nn::pia::inet::SetDebugSetting | ( | const DebugSetting & | debugSetting | ) |
(デバッグ用) inet のデバッグ用機能について設定します。
本関数は inet のインスタンスが存在しない状態で呼出可能です。 DebugSetting 構造体の isEnableNatErrorEmulation を true に設定した場合、NATトラバーサルがエラーで失敗する設定となります。 本関数を呼び出さなかった場合、本関数が関連するデバッグ用機能は全て無効(使用しない)設定となります。