CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_LocalCreateSessionSetting.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_CreateSessionSetting.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 class LocalCreateNetworkSetting;
33 
34 /*!
35  @brief LocalFacade の CreateSession に関する設定を管理する基底クラスです。
36 
37  @details アプリケーションが本クラスのインスタンスを作成することはありません。
38  本クラスを継承したクラスを使用してください。
39  @if CTR_DOC
40  @see nn::pia::local::UdsCreateSessionSetting
41  @elseif NIN_DOC
42  @see nn::pia::local::LdnCreateSessionSetting
43  @endif
44  */
46 {
47 public:
48  /*!
49  @cond PRIVATE
50  @brief デストラクタ。
51  */
52  virtual ~LocalCreateSessionSetting();
53  //! @endcond
54 
55  virtual const LocalCreateNetworkSetting* GetLocalCreateNetworkSetting() const = 0;
56 
57  /*!
58  @brief 設定をリセットします。
59  */
60  virtual void Reset();
61 
62  /*!
63  @brief 作成したセッションにユーザーパスワードを設定します。
64  @details 初期値は空文字列です。設定されなかった場合や空文字列が設定された場合はユーザーパスワードの設定されていないセッションとなります。
65  @param[in] userPassword 設定するユーザーパスワード
66  @return ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
67 
68  @retval nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
69  */
70  virtual Result SetSessionUserPassword(const common::String& userPassword);
71 
72  /*!
73  @cond PRIVATE
74  */
75  const common::String& GetSessionUserPassword() const;
76  //bool IsSetSessionUserPassword() const;
77  //! @endcond
78 
79  // デバッグに有用な情報をプリント。
80  virtual void Trace(uint64_t flag) const;
81 
82 protected:
83  /*!
84  @cond PRIVATE
85  @brief デフォルトコンストラクタ。
86  */
88  //! @endcond
89 
90  void Copy(const LocalCreateSessionSetting& rhs);
91 
92 private:
93  NN_PIA_DISALLOW_COPY(LocalCreateSessionSetting);
95 };
96 }
97 }
98 } // end of namespace nn::pia::local