CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
inet_NexSessionSearchCriteriaSessionId.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 #include <nn/pia/session/session_SessionSearchCriteria.h>
22 
23 namespace nn
24 {
25 namespace pia
26 {
27 namespace inet
28 {
29 
30 /*!
31  @brief セッション ID を検索条件に指定するクラスです。
32  @details nn::pia::session::Session::CreateInstance 呼び出し時に指定する
33  nn::pia::session::Session::Setting 構造体の browsedSessionInfoListNum は 1 以上の値を
34  指定する必要があります。
35 
36  @see nn::pia::session::SessionSearchCriteria
37  */
39 {
40 public:
41  /*!
42  @brief デフォルトコンストラクタ。
43  */
45 
46  /*!
47  @brief コンストラクタ。
48  @param[in] sessionId 検索条件として指定するセッション ID。
49  */
50  NexSessionSearchCriteriaSessionId(uint32_t sessionId);
51 
52  /*!
53  @brief デストラクタ。
54  */
56 
57  /*!
58  @brief 検索条件として指定するセッション ID をセットします。
59  @param[in] sessionId 検索条件として指定するセッション ID。
60  */
61  void SetSessionId(uint32_t sessionId);
62 
63  /*!
64  @brief 代入演算子です。
65  @param[in] rhs 代入するオブジェクトです。
66  @return 本オブジェクトへの参照。
67  */
69 
70  /*!
71  @brief 設定をコピーします。
72  @param[in] rhs コピー元のオブジェクトです。
73  */
74  void Copy(const NexSessionSearchCriteriaSessionId& rhs);
75 
76  /*!
77  @brief コピーコンストラクタ。
78  @param[in] rhs コピー元のオブジェクトです。
79  */
81 
82  /*!
83  @cond PRIVATE
84  */
85  uint32_t GetSessionId() const;
86  //! @endcond
87 
88  /*!
89  @brief 検索条件をリセットします。
90  */
91  virtual void Reset();
92 
93 private:
94  // SetResultRange は封印。
95  virtual Result SetResultRange(uint32_t offset, uint32_t size);
96 
97  uint32_t m_SessionId;
98 };
99 }
100 }
101 } // end of namespace nn::pia::inet
102 
103 #endif