CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
lan_LanJoinRandomSessionSetting.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/lan/lan_Definitions.h>
17 
18 #include <nn/pia/session/session_JoinRandomSessionSetting.h>
19 #include <nn/pia/lan/lan_LanCreateSessionSetting.h>
20 #include <nn/pia/lan/lan_LanSessionSearchCriteria.h>
21 
22 namespace nn
23 {
24 namespace pia
25 {
26 namespace lan
27 {
28 /*!
29  @brief ランダムマッチメイク処理に関する設定を管理するクラスです。
30 
31  @see nn::pia::session::JoinRandomSessionSetting
32  */
34 {
35 public:
36  /*!
37  @brief デフォルトコンストラクタ。
38  */
40 
41  /*!
42  @brief デストラクタ。
43  */
45 
46  /*!
47  @brief ランダムマッチメイクのセッション作成時の設定を指定します。
48  @param[in] pSetting セッション作成時の設定。
49  */
51 
52  /*!
53  @brief ランダムマッチメイクのセッション検索時の設定を指定します。
54  @param[in] pSearchCriteria セッション検索設定のリスト。
55  @param[in] searchCriteriaSize セッション検索設定のリストサイズ。LanSessionSearchCriteriaListSizeMax 以下である必要があります。
56  */
57  virtual Result SetSessionSearchCriteria(const session::SessionSearchCriteria* pSearchCriteria, uint32_t searchCriteriaSize);
58 
59  /*!
60  @brief 代入演算子です。
61  @param[in] rhs 代入するオブジェクトです。
62  @return 本オブジェクトへの参照。
63  */
65 
66  /*!
67  @brief 設定をコピーします。
68  @param[in] rhs コピー元のオブジェクトです。
69  */
70  void Copy(const LanJoinRandomSessionSetting& rhs);
71 
72  /*!
73  @brief コピーコンストラクタ。
74  @param[in] rhs コピー元のオブジェクトです。
75  */
77 
78  /*!
79  @brief 設定をリセットします。
80  */
81  virtual void Reset();
82 
83  /*!
84  @cond PRIVATE
85  @brief デバッグに有用な情報をプリント。
86  */
87  virtual void Trace(uint64_t flag) const;
88  //! @endcond
89 
90  /*!
91  @cond PRIVATE
92  */
93  virtual session::CreateSessionSetting* GetCreateSessionSetting();
94  virtual session::SessionSearchCriteria* GetSessionSearchCriteria(uint8_t index);
95  virtual const session::CreateSessionSetting* GetCreateSessionSetting() const;
96  virtual const session::SessionSearchCriteria* GetSessionSearchCriteria(uint8_t index) const;
97  virtual uint32_t GetSessionSearchCriteriaSize() const
98  {
99  return m_SessionSearchCriteriaSize;
100  }
101  //! @endcond
102 
103 protected:
104 
105  LanCreateSessionSetting m_CreateSessionSetting;
107  uint32_t m_SessionSearchCriteriaSize;
108 
109 private:
110 };
111 }
112 }
113 } // end of namespace nn::pia::lan