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

PiaLan の名前空間です。 PiaLan は LAN P2P 通信機能を提供するネットワーク管理モジュールです。LAN マッチメイク機能を提供します。PiaSession と一緒に使用します。 [詳細]

構成

class  LanCreateSessionSetting
 LAN マッチメイクのセッション構築処理に関する設定を管理するクラスです。 [詳細]
 
class  LanFacade
 LAN マッチメイクのファサード(facade、インターフェースラッパー)クラスです。 [詳細]
 
class  LanJoinRandomSessionSetting
 ランダムマッチメイク処理に関する設定を管理するクラスです。 [詳細]
 
class  LanJoinSessionSetting
 LAN マッチメイクのセッション参加処理に関する設定を管理するクラスです。 [詳細]
 
class  LanNetworkFactory
 同一サブネットの LAN ネットワークに必要なクラスを生成するためのクラスです(ファクトリパターン)。 [詳細]
 
class  LanSessionInfo
 LAN マッチメイクのセッション情報クラスです。 [詳細]
 
class  LanSessionSearchCriteria
 LAN マッチメイクのセッションを検索する際に使用する検索条件のクラスです。 [詳細]
 
struct  LanSessionStartupSetting
 nn::pia::session::Session::Startup に渡す設定用構造体です。 [詳細]
 
class  LanStationInfo
 セッションに参加中のステーション情報です。 [詳細]
 
class  LanUpdateSessionSetting
 セッションの条件更新処理に関する情報を管理するクラスです。 [詳細]
 

列挙型

enum  LanSessionType { LanSessionType_Anybody = 0 }
 LAN マッチメイクのセッションタイプを表す列挙型です。 [詳細]
 

関数

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

変数

const int DefaultRttInitialPulseInterval = 600
 初期段階での RTT 計測パルス送信間隔のデフォルト値です。単位はミリ秒です。
 
const uint32_t KeepAliveSendingInterval = 400
 キープアライブの送信間隔 [msec] のデフォルト値です。
 
const uint32_t LanApplicationDataBufferSizeMax = 384
 セッションのアプリケーションデータの最大長
 
const uint32_t LanAttributeArraySizeMax = 20
 検索条件に指定できる属性値の配列の最大長
 
const uint32_t LanAttributeSizeMax = 6
 セッションに指定可能な属性の数
 
const uint32_t LanCommunityInfoListSizeMax = 0
 検索可能なコミュニティ数の最大長
 
const uint32_t LanSessionInfoListSizeMax = 10
 検索可能なセッション数の最大長
 
const uint8_t LanSessionSearchCriteriaListSizeMax = 2
 ランダムマッチメイク時に指定する検索条件の最大数
 
const uint32_t MaxSilenceTime = 4000
 ステーションとの通信が断絶したと判断する無通信時間 [msec] のデフォルト値です。
 

説明

PiaLan の名前空間です。 PiaLan は LAN P2P 通信機能を提供するネットワーク管理モジュールです。LAN マッチメイク機能を提供します。PiaSession と一緒に使用します。

列挙型

LAN マッチメイクのセッションタイプを表す列挙型です。

列挙型の値:
LanSessionType_Anybody 

誰でも参加可能

関数

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

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

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

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

ResultNotInitialized lan モジュールの初期化関数が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

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

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

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

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

ResultNotInitialized lan モジュールの初期化関数が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

Result nn::pia::lan::Initialize ( )

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

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

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

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