CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_LocalJoinSessionSetting.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 #include <nn/pia/session/session_JoinSessionSetting.h>
19 #include <nn/pia/local/local_LocalSessionTypes.h>
20 
21 #include <nn/pia/common/common_SignatureSetting.h>
22 #include <nn/pia/common/common_FixedString.h>
23 
24 namespace nn
25 {
26 namespace pia
27 {
28 namespace local
29 {
30 
31 /*!
32  @brief LocalFacade の JoinSession に関する設定を管理する基底クラスです。
33 
34  @details アプリケーションが本クラスのインスタンスを作成することはありません。
35  本クラスを継承したクラスを使用してください。
36 
37  @if CTR_DOC
38  @see nn::pia::local::UdsJoinSessionSetting
39  @elseif NIN_DOC
40  @see nn::pia::local::LdnJoinSessionSetting
41  @endif
42  */
44 {
45 public:
46  /*!
47  @cond PRIVATE
48  @brief デストラクタ。
49  */
50  virtual ~LocalJoinSessionSetting();
51  //! @endcond
52 
53  /*!
54  @cond PRIVATE
55  */
56  virtual const char* GetWirelessCryptoKey() const = 0;
57  //! @endcond
58 
59  /*!
60  @cond PRIVATE
61  */
62  uint8_t GetWirelessCryptoKeySize() const
63  {
64  return m_WirelessCryptoKeySize;
65  }
66  //! @endcond
67 
68  virtual Result SetWirelessCryptoKey(const char* pWirelessCryptoKey, uint8_t wirelessCryptoKeySize) = 0;
69 
70  /*!
71  @cond PRIVATE
72  */
73  virtual uint32_t GetSessionId() const;
74  //! @endcond
75 
76  /*!
77  @brief セッションのユーザーパスワードを設定します。
78  @details セッションにユーザーパスワードが設定されている場合に一致が確認されます。 初期状態は空文字列です。
79  @param[in] userPassword ユーザーパスワード
80  @return ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
81 
82  @retval nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
83  */
84  virtual Result SetSessionUserPassword(const common::String& userPassword);
85 
86  /*!
87  @cond PRIVATE
88  */
89  const common::String& GetSessionUserPassword() const;
90  //bool IsSetSessionUserPassword() const;
91  //! @endcond
92 
93  /*!
94  @brief 設定をリセットします。
95  */
96  virtual void Reset();
97 
98 protected:
99  uint8_t m_WirelessCryptoKeySize;
100 
101  /*!
102  @cond PRIVATE
103  @brief デフォルトコンストラクタ。
104  */
106  //! @endcond
107 
108 private:
109  // コピーコンストラクタは封印。
111 
112  // 代入演算子は封印。
114 
116 };
117 }
118 }
119 } // end of namespace nn::pia::local