CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
inet_NexJoinSessionSetting.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/inet/inet_Definitions.h>
17 
18 #if NN_PIA_ENABLE_NEX
19 
20 #include <nn/pia/inet/inet_NexSessionTypes.h>
21 
22 #include <nn/pia/common/common_FixedString.h>
23 #include <nn/pia/session/session_JoinSessionSetting.h>
24 
25 namespace nn
26 {
27 namespace pia
28 {
29 namespace inet
30 {
31 /*!
32  @brief セッション参加処理に関する設定を管理するクラスです。
33 
34  @see nn::pia::session::JoinSessionSetting
35  */
36 
38 {
39 public:
40  /*!
41  @brief デフォルトコンストラクタ。
42  */
44 
45  /*!
46  @brief デストラクタ。
47  */
48  virtual ~NexJoinSessionSetting();
49 
50  /*!
51  @brief ブロックリストを設定します。
52  @param[in] isMyBlockListUsed 自分がブロックリストに登録しているユーザーをチェックするかどうか。デフォルトは true です。
53  @param[in] isOthersBlockListUsed 自分をブロックリストに登録しているユーザをチェックするかどうか。デフォルトは true です。
54  */
55  void SetBlockListOption(bool isMyBlockListUsed, bool isOthersBlockListUsed);
56 
57  /*!
58  @brief セッションのユーザーパスワードを設定します。
59  @details セッションにユーザーパスワードが設定されている場合に一致が確認されます。 初期状態は空文字列です。
60  @param[in] userPassword ユーザーパスワード。パスワードの文字列は SessionUserPasswordLengthMax 以下である必要があります。
61  @return ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
62 
63  @retval nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
64  */
65  Result SetSessionUserPassword(const common::String& userPassword);
66 
67  /*!
68  @brief セッションのシステムパスワードを設定します。
69  @details セッションにシステムパスワードが設定されている場合に一致が確認されます。 初期状態は空文字列です。
70  @param[in] systemPassword システムパスワード。パスワードの文字列は SessionSystemPasswordLengthMax 以下である必要があります。
71  @return システムパスワードの指定に成功すれば、成功の Result が返されます。
72 
73  @retval nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはシステムパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
74  */
75  Result SetSessionSystemPassword(const common::String& systemPassword);
76 
77  /*!
78  @cond PRIVATE
79  @brief
80  */
81  void SetExtraParticipantNum(uint16_t num);
82  //! @endcond
83 
84  /*!
85  @cond PRIVATE
86  @brief セッションのマッチメイクセッションオプションを指定します。
87  @param[in] option セッションに指定するマッチメイクセッションオプション。
88  */
89  void SetMatchmakeSessionOption(uint32_t option);
90  //! @endcond
91 
92  /*!
93  @brief 代入演算子です。
94  @param[in] rhs 代入するオブジェクトです。
95  @return 本オブジェクトへの参照。
96  */
98 
99  /*!
100  @brief 設定をコピーします。
101  @param[in] rhs コピー元のオブジェクトです。
102  */
103  void Copy(const NexJoinSessionSetting& rhs);
104 
105  /*!
106  @brief コピーコンストラクタ。
107  @param[in] rhs コピー元のオブジェクトです。
108  */
110 
111  /*!
112  @cond PRIVATE
113  */
114  const common::String& GetSessionUserPassword() const;
115  const common::String& GetSessionSystemPassword() const;
116  uint16_t GetExtraParticipantNum() const;
117  uint32_t GetMatchmakeSessionOption() const;
118  bool IsSetMatchmakeSessionOption() const;
119  bool IsMyBlockListUsed() const;
120  bool IsOthersBlockListUsed() const;
121  //! @endcond
122 
123  /*!
124  @brief 設定をリセットします。
125  */
126  virtual void Reset();
127 
128 protected:
131 
132  uint16_t m_ExtraParticipantNum;
133  uint32_t m_MatchmakeSessionOption;
134  bool m_IsSetMatchmakeSessionoption;
135  bool m_IsMyBlockListUsed;
136  bool m_IsOthersBlockListUsed;
137 
138 private:
139 };
140 }
141 }
142 } // end of namespace nn::pia::inet
143 
144 #endif