CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_LdnJoinSessionSetting.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 
18 #if NN_PIA_NINTENDOSDK
19 
20 #include <nn/pia/local/local_LocalJoinSessionSetting.h>
21 #include <nn/pia/local/local_LdnNetworkSetting.h>
22 
23 namespace nn
24 {
25 namespace pia
26 {
27 namespace local
28 {
29 /*!
30  @brief LDN ライブラリ(ローカル通信)を利用したネットワークの JoinSession に関する設定を管理するクラスです。
31  */
32 
33 class LdnJoinSessionSetting : public LocalJoinSessionSetting
34 {
35 public:
36  /*!
37  @brief デフォルトコンストラクタ。
38  */
39  LdnJoinSessionSetting();
40  /*!
41  @brief デストラクタ。
42  */
43  virtual ~LdnJoinSessionSetting() {};
44 
45  /*!
46  @cond PRIVATE
47  */
48  virtual const char* GetWirelessCryptoKey() const
49  {
50  return m_WirelessCryptoKey;
51  }
52  //! @endcond
53 
54  /*!
55  @brief 無線レイヤの暗号化に使用する暗号鍵とそのサイズを設定します。
56 
57  @details 暗号鍵のサイズは、@ref LdnWirelessCryptoKeySizeMin 以上、 @ref LdnWirelessCryptoKeySizeMax 以下にする必要があります。
58 
59  @param[in] pWirelessCryptoKey 無線レイヤの暗号化に使用する暗号鍵です。
60  @param[in] wirelessCryptoKeySize 無線レイヤの暗号化に使用する暗号鍵のサイズです。
61 
62  @return 成功すれば、 IsSuccess() が true を返す Result が返されます。
63 
64  @retval ResultInvalidArgument 引数の指定が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
65  */
66  virtual Result SetWirelessCryptoKey(const char* pWirelessCryptoKey, uint8_t wirelessCryptoKeySize);
67 
68  /*!
69  @brief 設定をリセットします。
70  */
71  virtual void Reset();
72 
73 protected:
74  char m_WirelessCryptoKey[LdnWirelessCryptoKeySizeMax];
75 
76 private:
77  // コピーコンストラクタは封印。
78  LdnJoinSessionSetting(const LdnJoinSessionSetting&);
79 
80  // 代入演算子は封印。
81  LdnJoinSessionSetting& operator=(const LdnJoinSessionSetting&);
82 };
83 }
84 }
85 } // end of namespace nn::pia::local
86 #endif