CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
session_JoinRandomSessionSetting.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/session/session_Definitions.h>
17 
18 #include <nn/pia/session/session_CreateSessionSetting.h>
19 #include <nn/pia/session/session_SessionSearchCriteria.h>
20 
21 namespace nn
22 {
23 namespace pia
24 {
25 namespace session
26 {
27 /*!
28  @brief ランダムマッチメイク処理に関する設定を管理する基底クラスです。
29  @details アプリケーションが本クラスのインスタンスを作成することはありません。 本クラスを継承したクラスを使用する必要があります。
30 
31  @see inet::NexJoinRandomSessionSetting
32  @see lan::LanJoinRandomSessionSetting
33  */
35 {
36 public:
37  /*!
38  @brief デストラクタ。
39  */
41 
42  /*!
43  @brief ランダムマッチメイクのセッション作成時の設定を指定します。
44  @param[in] pSetting セッション作成時の設定。
45  */
46  virtual Result SetCreateSessionSetting(const CreateSessionSetting* pSetting) = 0;
47 
48  /*!
49  @brief ランダムマッチメイクのセッション検索時の設定を指定します。
50  @param[in] pSearchCriteria セッション検索設定のリスト。
51  @param[in] searchCriteriaSize セッション検索設定のリストサイズ。
52  */
53  virtual Result SetSessionSearchCriteria(const SessionSearchCriteria* pSearchCriteria, uint32_t searchCriteriaSize) = 0;
54 
55  /*!
56  @brief 設定をリセットします。
57  */
58  virtual void Reset() = 0;
59 
60  /*!
61  @cond PRIVATE
62  @brief デバッグに有用な情報をプリント。
63  */
64  virtual void Trace(uint64_t flag) const = 0;
65  //! @endcond
66 
67  /*!
68  @cond PRIVATE
69  */
70  virtual CreateSessionSetting* GetCreateSessionSetting() = 0;
71  virtual SessionSearchCriteria* GetSessionSearchCriteria(uint8_t index) = 0;
72  virtual const CreateSessionSetting* GetCreateSessionSetting() const = 0;
73  virtual const SessionSearchCriteria* GetSessionSearchCriteria(uint8_t index) const = 0;
74  virtual uint32_t GetSessionSearchCriteriaSize() const = 0;
75  //! @endcond
76 
77 protected:
78  // デフォルトコンストラクタ
80 
81 private:
82  NN_PIA_DISALLOW_COPY(JoinRandomSessionSetting);
83 };
84 }
85 }
86 } // end of namespace session