CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_UdsJoinSessionSetting.h
1 /*--------------------------------------------------------------------------------*
2  Copyright (C)Nintendo All rights reserved.
3 
4  These coded instructions, statements, and computer programs contain proprietary
5  information of Nintendo and/or its licensed developers and are protected by
6  national and international copyright laws. They may not be disclosed to third
7  parties or copied or duplicated in any form, in whole or in part, without the
8  prior written consent of Nintendo.
9 
10  The content herein is highly confidential and should be handled accordingly.
11  *--------------------------------------------------------------------------------*/
12 
13 
14 #pragma once
15 
16 #include <nn/pia/local/local_Definitions.h>
17 #if NN_PIA_LOCAL_ENABLE_UDS
18 #include <nn/pia/local/local_LocalJoinSessionSetting.h>
19 
20 namespace nn
21 {
22 namespace pia
23 {
24 namespace local
25 {
26 /*!
27  @brief UDS ライブラリ(ローカル通信)を利用したネットワークの JoinSession に関する設定を管理するクラスです。
28  */
29 
31 {
32 public:
33  //! 無線レイヤの暗号化に使用する暗号鍵の最小サイズです。
34  static const uint8_t WirelessCryptoKeyLengthMin = nn::uds::UDS_PASSPHRASE_LENGTH_MIN;
35 
36  //! 無線レイヤの暗号化に使用する暗号鍵の最大サイズです。
37  static const uint8_t WirelessCryptoKeyLengthMax = nn::uds::UDS_PASSPHRASE_LENGTH_MAX;
38 
39  /*!
40  @brief デフォルトコンストラクタ。
41  */
43 
44  /*!
45  @brief デストラクタ。
46  */
47  virtual ~UdsJoinSessionSetting() {};
48 
49  /*!
50  @cond PRIVATE
51  */
52  virtual const char* GetWirelessCryptoKey() const
53  {
54  return m_WirelessCryptoKey;
55  }
56  //! @endcond
57 
58  /*!
59  @brief 無線レイヤの暗号化に使用する暗号鍵とそのサイズを設定します。
60 
61  @details 暗号鍵のサイズは、@ref WirelessCryptoKeyLengthMin 以上、 @ref WirelessCryptoKeyLengthMax 以下である必要があります。
62 
63  @param[in] pWirelessCryptoKey 無線レイヤの暗号化に使用する暗号鍵です。
64  @param[in] wirelessCryptoKeySize 無線レイヤの暗号化に使用する暗号鍵のサイズです。
65 
66  @return 成功すれば、 IsSuccess() が true を返す Result が返されます。
67 
68  @retval ResultInvalidArgument 引数の指定が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
69  */
70  virtual Result SetWirelessCryptoKey(const char* pWirelessCryptoKey, uint8_t wirelessCryptoKeySize);
71 
72  /*!
73  @brief 設定をリセットします。
74  */
75  virtual void Reset();
76 
77 protected:
78  char m_WirelessCryptoKey[WirelessCryptoKeyLengthMax];
79 
80 private:
81  // コピーコンストラクタは封印。
83 
84  // 代入演算子は封印。
86 };
87 }
88 }
89 } // end of namespace nn::pia::local
90 #endif