CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_LocalUpdateSessionSetting.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 #include <nn/pia/local/local_LocalSessionTypes.h>
18 
19 #include <nn/pia/session/session_UpdateSessionSetting.h>
20 
21 namespace nn
22 {
23 namespace pia
24 {
25 namespace local
26 {
27 
28 /*!
29  @brief セッションの条件更新処理に関する設定を管理するクラスです。
30  @details アプリケーションが本クラスのインスタンスを作成することはありません。 本クラスを継承したクラスを使用してください。
31 
32  @if CTR_DOC
33  @see local::UdsUpdateSessionSetting
34  @elseif NIN_DOC
35  @see local::LdnUpdateSessionSetting
36  @endif
37  */
38 
40 {
41 public:
42  /*!
43  @brief デストラクタ
44  */
46 
47  /*!
48  @cond PRIVATE
49  @brief アプリケーション定義データのバッファへのポインタを取得します。
50  @return アプリケーション定義データのバッファへのポインタが返されます。
51  */
52  virtual const uint8_t* GetApplicationDataPtr() const = 0;
53  //! @endcond
54 
55  /*!
56  @cond PRIVATE
57  @brief アプリケーション定義データのバッファサイズを取得します。
58  @return アプリケーション定義データのバッファサイズが返されます。
59  */
60  virtual uint32_t GetApplicationDataSizeMax() const = 0;
61  //! @endcond
62 
63  /*!
64  @cond PRIVATE
65  @brief 指定したアプリケーション定義のデータサイズを取得します。
66  @return アプリケーション定義データサイズが返されます。
67  */
68  virtual uint32_t GetApplicationDataSize() const;
69  //! @endcond
70 
71  /*!
72  @brief 設定をリセットします。
73  */
74  virtual void Reset();
75 
76 protected:
77  // コンストラクタ。
79 
80  void Copy(const LocalUpdateSessionSetting& rhs);
81 
82  uint32_t m_ApplicationDataSize;
83 
84 private:
85  NN_PIA_DISALLOW_COPY(LocalUpdateSessionSetting);
86 };
87 }
88 }
89 } // end of namespace local