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

UDS ライブラリ(ローカル通信)を利用したネットワークの CreateSession に関する設定を管理するクラスです。 [詳細]

+ nn::pia::local::UdsCreateSessionSettingに対する継承グラフ

Public メソッド

 UdsCreateSessionSetting ()
 デフォルトコンストラクタ。
 
 UdsCreateSessionSetting (const UdsCreateSessionSetting &rhs)
 コピーコンストラクタ。。
 
virtual ~UdsCreateSessionSetting ()
 デストラクタ。
 
void Copy (const UdsCreateSessionSetting &rhs)
 設定をコピーします。
 
UdsCreateSessionSettingoperator= (const UdsCreateSessionSetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
virtual Result SetApplicationData (const void *pData, uint32_t size)
 アプリケーション定義のデータを指定します。
 
void SetChannel (uint8_t channel)
 作成するセッションの通信に使用するチャンネルを指定します。
 
void SetLocalCommunicationId (uint32_t localCommunicationId)
 作成するセッションのローカル通信 ID を指定します。
 
virtual void SetMaxParticipantNum (uint16_t max)
 作成するセッションの最大参加人数を指定します。
 
void SetMinParticipantNum (uint16_t min)
 作成するセッションの最小参加人数を指定します。
 
virtual Result SetSessionUserPassword (const common::String &userPassword)
 作成したセッションにユーザーパスワードを設定します。
 
void SetSubId (uint8_t subId)
 作成するセッションの通信モード識別用 ID を指定します。
 
virtual Result SetWirelessCryptoKey (const char *pWirelessCryptoKey, uint8_t wirelessCryptoKeySize)
 無線レイヤの暗号化に使用する暗号鍵とそのサイズを設定します。
 

説明

UDS ライブラリ(ローカル通信)を利用したネットワークの CreateSession に関する設定を管理するクラスです。

コンストラクタとデストラクタ

nn::pia::local::UdsCreateSessionSetting::UdsCreateSessionSetting ( const UdsCreateSessionSetting rhs)

コピーコンストラクタ。。

引数
[in]rhsコピー元のオブジェクトです。

関数

void nn::pia::local::UdsCreateSessionSetting::Copy ( const UdsCreateSessionSetting rhs)

設定をコピーします。

引数
[in]rhsコピー元のオブジェクトです。
UdsCreateSessionSetting& nn::pia::local::UdsCreateSessionSetting::operator= ( const UdsCreateSessionSetting rhs)

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
virtual Result nn::pia::local::UdsCreateSessionSetting::SetApplicationData ( const void *  pData,
uint32_t  size 
)
virtual

アプリケーション定義のデータを指定します。

データのサイズは、UdsBeaconApplicationDataSizeMax 以下である必要があります。

引数
[in]pData構築するセッションに指定するアプリケーション定義データのバッファ。
[in]size構築するセッションに指定するアプリケーション定義データのサイズ。
戻り値
アプリケーション定義データの設定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument バッファが NULL ポインタ、または指定したデータサイズが大きすぎます。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::session::CreateSessionSettingを実装しています。

void nn::pia::local::UdsCreateSessionSetting::SetChannel ( uint8_t  channel)
inline

作成するセッションの通信に使用するチャンネルを指定します。

引数
[in]channel通信に使用するチャンネルです。0(自動), 1,6,11ch のいずれかを指定する必要があります。製品実機で実行した場合は常にチャンネルを自動で選択します。
void nn::pia::local::UdsCreateSessionSetting::SetLocalCommunicationId ( uint32_t  localCommunicationId)
inline

作成するセッションのローカル通信 ID を指定します。

引数
[in]localCommunicationIdローカル通信 ID です。LocalFacade::CreateLocalCommunicationId で生成した値を指定する必要があります。
virtual void nn::pia::local::UdsCreateSessionSetting::SetMaxParticipantNum ( uint16_t  max)
inlinevirtual

作成するセッションの最大参加人数を指定します。

引数
[in]max作成するセッションに指定する最大参加人数。StationMaxEntry 以下である必要があります。

nn::pia::session::CreateSessionSettingを再定義しています。

void nn::pia::session::CreateSessionSetting::SetMinParticipantNum ( uint16_t  min)
inherited

作成するセッションの最小参加人数を指定します。

引数
[in]min作成するセッションに指定する最小参加人数。
virtual Result nn::pia::local::LocalCreateSessionSetting::SetSessionUserPassword ( const common::String userPassword)
virtualinherited

作成したセッションにユーザーパスワードを設定します。

初期値は空文字列です。設定されなかった場合や空文字列が設定された場合はユーザーパスワードの設定されていないセッションとなります。

引数
[in]userPassword設定するユーザーパスワード
戻り値
ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::local::UdsCreateSessionSetting::SetSubId ( uint8_t  subId)
inline

作成するセッションの通信モード識別用 ID を指定します。

引数
[in]subId通信モード識別用 ID です。0x00 から 0xFE の間で指定する必要があります。
virtual Result nn::pia::local::UdsCreateSessionSetting::SetWirelessCryptoKey ( const char *  pWirelessCryptoKey,
uint8_t  wirelessCryptoKeySize 
)
virtual

無線レイヤの暗号化に使用する暗号鍵とそのサイズを設定します。

暗号鍵のサイズは、UdsWirelessCryptoKeyLengthMin 以上、UdsWirelessCryptoKeyLengthMax 以下である必要があります。

引数
[in]pWirelessCryptoKey無線レイヤの暗号化に使用する暗号鍵です。
[in]wirelessCryptoKeySize無線レイヤの暗号化に使用する暗号鍵のサイズです。
戻り値
成功すれば、 IsSuccess() が true を返す Result が返されます。
返るエラーの一覧:
ResultInvalidArgument 引数の指定が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。