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

PiaLocal の名前空間です。 PiaLocal はローカル P2P 通信の拡張機能を提供するモジュールです。PiaSession と一緒に使用します。 [詳細]

構成

class  LocalCreateSessionSetting
 LocalFacade の CreateSession に関する設定を管理する基底クラスです。 [詳細]
 
class  LocalFacade
 ローカルネットワークを扱うためのクラスです。 [詳細]
 
class  LocalJoinSessionSetting
 LocalFacade の JoinSession に関する設定を管理する基底クラスです。 [詳細]
 
class  LocalNetworkFactory
 LocalFacade を利用したネットワークに必要なクラスを生成するための基底クラスです(ファクトリパターン)。 [詳細]
 
class  LocalNetworkSetting
 ローカルネットワークの設定用クラスです。 [詳細]
 
class  LocalSessionInfo
 ローカル通信のセッション情報クラスです。 [詳細]
 
class  LocalSessionSearchCriteria
 LocalFacade を利用したネットワークのセッションを検索する際に使用する検索条件の基底クラスです。 [詳細]
 
struct  LocalSessionStartupSetting
 nn::pia::session::Session::Startup に渡す設定用構造体です。 [詳細]
 
class  LocalStationInfo
 ローカルネットワークに接続しているステーションについての情報を保持するクラスです。 [詳細]
 
class  LocalUpdateSessionSetting
 セッションの条件更新処理に関する設定を管理するクラスです。 [詳細]
 
class  UdsCreateSessionSetting
 UDS ライブラリ(ローカル通信)を利用したネットワークの CreateSession に関する設定を管理するクラスです。 [詳細]
 
class  UdsJoinSessionSetting
 UDS ライブラリ(ローカル通信)を利用したネットワークの JoinSession に関する設定を管理するクラスです。 [詳細]
 
class  UdsNetworkFactory
 UDS ライブラリ(ローカル通信)を利用したネットワークに必要なクラスを生成するためのクラスです(ファクトリパターン)。 [詳細]
 
class  UdsNetworkSetting
 UDS ライブラリを利用したネットワークの設定用クラスです。 [詳細]
 
class  UdsSessionInfo
 ローカル通信のセッション情報クラスです。 [詳細]
 
class  UdsSessionSearchCriteria
 UDS ライブラリ(ローカル通信)を利用したネットワークのセッションを検索する際に使用する検索条件のクラスです。 [詳細]
 
class  UdsStationInfo
 UDS ライブラリを利用したネットワークに接続しているステーションについての情報を保持するクラスです。 [詳細]
 
class  UdsUpdateSessionSetting
 セッションの条件更新処理に関する設定を管理するクラスです。 [詳細]
 

列挙型

enum  DisconnectReason {
  DisconnectReason_None = 0,
  DisconnectReason_RequestFromMyself,
  DisconnectReason_RequestFromSystem,
  DisconnectReason_DiscardedFromNetwork,
  DisconnectReason_ConnectionLost,
  DisconnectReason_Unknown
}
 通信が切断した理由を表します。 [詳細]
 

関数

初期化終了処理
Result Initialize ()
 local モジュールを初期化します。
 
bool IsInitialized (void)
 local モジュールが初期化された状態であるかどうかを返します。
 
Result BeginSetup (void)
 セットアップの開始を宣言します。
 
Result EndSetup (void)
 セットアップの終了を宣言します。
 
void Finalize (void)
 local モジュールを終了します。
 

変数

const int BssIdSize = 6
 BssId のサイズ (Bytes)
 
const int DefaultRttInitialPulseInterval = 600
 初期段階での RTT 計測パルス送信間隔のデフォルト値です。単位はミリ秒です。
 
const uint32_t GatheringholderMaxSize = ScanNetworkNumMax
 保持するネットワークのスキャン結果の最大個数です。
 
const uint32_t KeepAliveSendingInterval = 400
 キープアライブの送信間隔 [msec] のデフォルト値です。
 
static const uint8_t LocalNetworkVersion = 1
 PiaLocal で扱うネットワークのバージョンです。
 
const uint32_t MaxSilenceTime = 4000
 ステーションとの通信が断絶したと判断する無通信時間 [msec] のデフォルト値です。
 
static const uint32_t ScanNetworkNumMax = 16
 ネットワーク探索をした際に、1度に保持できる探索結果の最大数です。
 
const uint32_t SessionUserPasswordLengthMax = 8
 ユーザーパスワードに設定できる最大文字数
 
static const uint8_t StationMaxEntry = 12
 最大接続台数です。ローカルネットワークホストも接続台数に含まれる点に注意してください。
 
static const uint32_t UdsBeaconApplicationDataSizeMax = nn::uds::NET_DESC_APPDATA_SIZE_MAX - UdsBeaconSystemDataSize
 アプリケーションがビーコンにセットできるデータの最大サイズです。
 
static const uint32_t UdsReceiveBufferSizeMin = 4 * 4096
 受信バッファの最小サイズです。
 
static const uint32_t UdsScanBufferSizeMin = 1 * 1024
 スキャンバッファの最小サイズです。
 
static const uint8_t UdsWirelessCryptoKeyLengthMax = nn::uds::UDS_PASSPHRASE_LENGTH_MAX
 通信に使用する暗号鍵生成のパスフレーズの最大サイズです。
 
static const uint8_t UdsWirelessCryptoKeyLengthMin = nn::uds::UDS_PASSPHRASE_LENGTH_MIN
 通信に使用する暗号鍵生成のパスフレーズの最小サイズです。
 

説明

PiaLocal の名前空間です。 PiaLocal はローカル P2P 通信の拡張機能を提供するモジュールです。PiaSession と一緒に使用します。

列挙型

通信が切断した理由を表します。

列挙型の値:
DisconnectReason_None 

まだ通信を開始していない、または接続は維持されています。

DisconnectReason_RequestFromMyself 

自身の操作でネットワークから切断しました。

DisconnectReason_RequestFromSystem 

システムからの要求 (無線オフモードへの遷移、スリープ遷移) でネットワークから切断しました。

DisconnectReason_DiscardedFromNetwork 

ホストがネットワークを破棄しました。または、ホストからの指示でネットワークから追放されました。または、通信状況が悪化し、ホストの内部状態でクライアントが切断されたことになりました。

DisconnectReason_ConnectionLost 

通信状況が悪化し、ホストからのビーコンが一定期間受信できず、接続が維持できなくなりました。

DisconnectReason_Unknown 

未知の理由で切断されました。

関数

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

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

local モジュール以下の初期化処理の前、すなわち LocalFacade::CreateInstance および LocalFacade::Initialize を実行する前に呼ぶ必要があります。

注意
別のモジュールのセットアップ処理とバッティングすると正しく動作しません。
BeginSetup 呼出後、local モジュール以下の初期化処理を行い、速やかに EndSetup を呼出してセットアップを完了させる必要があります。
戻り値
このAPIを適切なタイミングで呼び出していれば、成功のResultが返されます。
返るエラーの一覧:

ResultNotInitialized local モジュールが初期化されていません。

ResultInvalidState この関数を呼び出すタイミングが誤っています。

Result nn::pia::local::EndSetup ( void  )

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

local モジュール以下の初期化処理の後、すなわち LocalFacade::CreateInstance および LocalFacade::Initialize を実行した後に呼ぶ必要があります。
このAPI呼び出しにより、local モジュールのシングルトンなどが消費するメモリを確定し、ライブラリ内部でのメモリ管理を最適化します。

注意
別のモジュールのセットアップ処理とバッティングすると正しく動作しません。
BeginSetup 呼出後、local モジュール以下の初期化処理を行い、速やかに EndSetup を呼出してセットアップを完了させる必要があります。
戻り値
このAPIを適切なタイミングで呼び出していれば、成功のResultが返されます。
返るエラーの一覧:

ResultNotInitialized local モジュールが初期化されていません。

ResultInvalidState この関数を呼び出すタイミングが誤っています。

void nn::pia::local::Finalize ( void  )

local モジュールを終了します。

本関数を実行する前に PiaLocal モジュールのすべての処理を終了しておく必要があります。 なお、nn::pia::local::Initialize を実行していない状態では何もしません。

Result nn::pia::local::Initialize ( )

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

事前に nn::pia::common::Initialize を実行する必要があります。

戻り値
無事に初期化が完了すれば、成功のResultが返されます。
返るエラーの一覧:

ResultInvalidState nn::pia::commonが初期化されていません。

ResultAlreadyInitialized 既に初期化は終了しています。

bool nn::pia::local::IsInitialized ( void  )

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

戻り値
初期化されていれば true 、されていなければ false が返されます。