CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_Api.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 
18 
19 // local モジュールの非メンバ関数群です。
20 
21 namespace nn
22 {
23 namespace pia
24 {
25 namespace local
26 {
27 /*! @name 初期化終了処理
28  @{
29  */
30 
31 /*!
32  @brief local モジュールを初期化します。
33 
34  @details 事前に nn::pia::common::Initialize を実行する必要があります。
35 
36  @return 無事に初期化が完了すれば、成功のResultが返されます。
37 
38  @retval ResultInvalidState nn::pia::commonが初期化されていません。
39  @retval ResultAlreadyInitialized 既に初期化は終了しています。
40  */
42 
43 /*!
44  @brief local モジュールが初期化された状態であるかどうかを返します。
45 
46  @return 初期化されていれば true 、されていなければ false が返されます。
47  */
48 bool IsInitialized(void);
49 
50 /*!
51  @brief セットアップの開始を宣言します。
52 
53  @details local モジュール以下の初期化処理の前、すなわち @ref LocalFacade::CreateInstance および @ref LocalFacade::Initialize を実行する前に呼ぶ必要があります。
54 
55  @attention 別のモジュールのセットアップ処理とバッティングすると正しく動作しません。<br>
56  @ref BeginSetup 呼出後、local モジュール以下の初期化処理を行い、速やかに @ref EndSetup を呼出してセットアップを完了させる必要があります。
57 
58  @return このAPIを適切なタイミングで呼び出していれば、成功のResultが返されます。
59 
60  @retval ResultNotInitialized local モジュールが初期化されていません。
61  @retval ResultInvalidState この関数を呼び出すタイミングが誤っています。
62  */
63 Result BeginSetup(void);
64 
65 /*!
66  @brief セットアップの終了を宣言します。
67 
68  @details local モジュール以下の初期化処理の後、すなわち @ref LocalFacade::CreateInstance および @ref LocalFacade::Initialize を実行した後に呼ぶ必要があります。 <br>
69  このAPI呼び出しにより、local モジュールのシングルトンなどが消費するメモリを確定し、ライブラリ内部でのメモリ管理を最適化します。
70 
71  @attention 別のモジュールのセットアップ処理とバッティングすると正しく動作しません。<br>
72  @ref BeginSetup 呼出後、local モジュール以下の初期化処理を行い、速やかに @ref EndSetup を呼出してセットアップを完了させる必要があります。
73 
74  @return このAPIを適切なタイミングで呼び出していれば、成功のResultが返されます。
75 
76  @retval ResultNotInitialized local モジュールが初期化されていません。
77  @retval ResultInvalidState この関数を呼び出すタイミングが誤っています。
78  */
79 Result EndSetup(void);
80 
81 /// @cond PRIVATE
82 bool IsDuringSetup(void);
83 /// @endcond
84 
85 /*!
86  @brief local モジュールを終了します。
87 
88  @details 本関数を実行する前に PiaLocal モジュールのすべての処理を終了しておく必要があります。
89  なお、@ref nn::pia::local::Initialize を実行していない状態では何もしません。
90  */
91 void Finalize(void);
92 /*!
93  end of name 初期化終了処理
94  @}
95  */
96 }
97 }
98 } // end of namespace nn::pia::local