1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: boss_TaskPolicy.h 4 5 Copyright (C)2009 Nintendo Co., Ltd. All rights reserved. 6 7 These coded instructions, statements, and computer programs contain 8 proprietary information of Nintendo of America Inc. and/or Nintendo 9 Company Ltd., and are protected by Federal copyright law. They may 10 not be disclosed to third parties or copied or duplicated in any form, 11 in whole or in part, without the prior written consent of Nintendo. 12 13 $Rev: 35264 $ 14 *---------------------------------------------------------------------------*/ 15 16 #ifndef NN_BOSS_BOSS_TASK_POLICY_H_ 17 #define NN_BOSS_BOSS_TASK_POLICY_H_ 18 19 #include <nn/boss/boss_Const.h> 20 #include <nn/boss/boss_Result.h> 21 #include <nn/boss/boss_Types.h> 22 23 #ifdef __cplusplus 24 25 namespace nn { 26 namespace boss { 27 28 /*! 29 @brief タスクポリシーを表すクラスです。タスクを登録する際のポリシー情報設定などに利用します。 30 */ 31 class TaskPolicy 32 { 33 public: 34 /*! 35 @brief コンストラクタです。 36 */ 37 explicit TaskPolicy(void); 38 39 /*! 40 @brief デストラクタです。 41 */ 42 virtual ~TaskPolicy(void); 43 44 /*! 45 @brief ポリシーの設定を行います。この初期化によってオブジェクトの再利用が可能になります。 46 47 @ref SetProperty で設定可能なTASK_PERMISSIONは、この初期化によってデフォルト値のTASK_PERMISSION_IN_PARENTAL_CONTROL(ペアレンタルコントロール(インターネット通信)が有効でも動作可能なタスク)」に設定されます。 48 49 @param[in] interval タスクの実行間隔を指定します。単位は時間です。（1時間～168時間が利用できる有効な範囲です。） 50 @param[in] count タスクの実行回数を指定します。 51 @return 関数の実行結果を返します。以下に挙げる Result を返します。 52 @retval ResultSuccess 初期化に成功しました。 53 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 54 */ Initialize(u32 interval,u32 count)55 inline nn::Result Initialize(u32 interval, u32 count){return InitializeWithSecInterval(interval*60*60, count);} 56 57 /*! 58 @brief [デバッグ専用。正規の実行間隔は時間単位でしか許可されませんので、デバッグ以外では @ref Initialize を利用してください。]ポリシーの設定を行います。実行間隔は秒単位で指定します。 59 60 （1秒～168時間が利用できる有効な範囲です。） 61 62 @param[in] intervalSec タスクの実行間隔を指定します。単位は秒です。 63 @param[in] count タスクの実行回数を指定します。 64 @return 関数の実行結果を返します。以下に挙げる Result を返します。 65 @retval ResultSuccess 初期化に成功しました。 66 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 67 */ 68 nn::Result InitializeWithSecInterval(u32 intervalSec, u32 count); 69 70 /*! 71 @brief ポリシーの設定を行います。 72 73 @param[in] priority タスク実行の優先度を指定します。 74 @param[in] interval タスクの実行間隔を指定します。単位は時間です。（1時間～168時間が利用できる有効な範囲です。） 75 @param[in] count タスクの実行回数を指定します。 76 @return 関数の実行結果を返します。以下に挙げる Result を返します。 77 @retval ResultSuccess 初期化に成功しました。 78 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 79 */ Initialize(TaskPriority priority,u32 interval,u32 count)80 inline nn::Result Initialize(TaskPriority priority, u32 interval, u32 count){return InitializeWithSecInterval(priority, interval*60*60, count);} 81 82 /*! 83 @brief [デバッグ専用。正規の実行間隔は時間単位でしか許可されませんので、デバッグ以外では @ref Initialize を利用してください。]ポリシーの設定を行います。実行間隔は秒単位で指定します。 84 85 （1秒～168時間が利用できる有効な範囲です。） 86 87 @param[in] priority タスク実行の優先度を指定します。 88 @param[in] intervalSec タスクの実行間隔を指定します。単位は秒です。 89 @param[in] count タスクの実行回数を指定します。 90 @return 関数の実行結果を返します。以下に挙げる Result を返します。 91 @retval ResultSuccess 初期化に成功しました。 92 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 93 */ 94 nn::Result InitializeWithSecInterval(TaskPriority priority, u32 intervalSec, u32 count); 95 96 /*! 97 @brief １回の実行時間の目安を設定します。（将来的にサポート予定です） 98 99 @param[in] duration １回の実行時間の目安を指定します。 100 @return 関数の実行結果を返します。以下に挙げる Result を返します。 101 @return 関数の実行結果を返します。以下に挙げる Result を返します。 102 @retval ResultSuccess 設定に成功しました。 103 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 104 */ 105 nn::Result SetDuration(u32 duration); 106 107 /*! 108 @brief タスク実行の優先度を設定します。 109 110 優先度の種類については、@ref TaskPriorityを参照ください。 111 通常、アプリケーションは、デフォルト値（@ref PRIORITY_MEDIUM）を使用しますので、変更する必要はありません。 112 特定のAPで動作させたいタスクの場合は、@ref PRIORITY_STOPPED に変更が必要になります。 113 タスク実行の優先度は、状況およびサーバからの設定に従いスケジューラによって適切に変更されます。 114 115 @param[in] priority タスク実行の優先度を指定します。 116 @return 関数の実行結果を返します。以下に挙げる Result を返します。 117 @retval ResultSuccess 設定に成功しました。 118 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 119 */ 120 nn::Result SetPriority(TaskPriority priority); 121 122 123 /*! 124 @brief クラス内のプロパティの値を設定します。 125 126 下記のプロパティを使用できます。 説明部のデータ型の領域を確保した後、呼び出してください。\n 127 識別子 説明 \n 128 TASK_PERMISSION タスク実行に伴うペアレンタルコントロール・EULAパーミッションの制御設定。データの型は、TaskPermission です。 \n 129 130 @param[in] type プロパティの識別子を指定します。 131 @param[in] pValue 値を指定します。 132 @param[in] size 値のサイズを指定します。 133 @return 関数の実行結果を返します。以下に挙げる Result を返します。 134 @retval ResultSuccess 設定に成功しました。 135 @retval ResultInvalidPropertyValue プロパティ値のポインタがNULLです。 136 @retval ResultInvalidPropertyType プロパティタイプがサポート外です。 137 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 138 */ 139 nn::Result SetProperty(PropertyType type, const void* pValue, size_t size); 140 141 /*! 142 @brief クラス内のプロパティの値を取得します。 143 144 下記のプロパティを使用できます。 説明部のデータ型の領域を確保した後、呼び出してください。\n 145 識別子 説明 \n 146 TASK_PRIORITY タスク登録時のタスク実行優先順位。データの型は、TaskPriorityです。 \n 147 TASK_SCHEDULING_POLICY タスクのスケジューリングポリシー。データの型は、SchedulingPolicyです。 \n 148 TASK_EXEC_INTERVAL タスクの実行間隔。データの型は、u32（秒）です。 \n 149 TASK_EXEC_COUNT タスクの消尽回数。データの型は、u16です。 \n 150 TASK_PERMISSION タスク実行に伴うペアレンタルコントロール・EULAパーミッションの制御設定。データの型は、TaskPermission です。明示的に設定しない場合はTASK_PERMISSION_IN_PARENTAL_CONTROLになります。 \n 151 152 @param[in] type プロパティの識別子を指定します。 153 @param[out] pValue 値を指定します。 154 @param[in] size 値のサイズを指定します。 155 @return 関数の実行結果を返します。以下に挙げる Result を返します。 156 @retval ResultSuccess 取得に成功しました。 157 @retval ResultInvalidPropertyValue プロパティ値のポインタがNULLです。 158 @retval ResultInvalidPropertyType プロパティタイプがサポート外です。 159 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 160 */ 161 nn::Result GetProperty(PropertyType type, void* pValue, size_t size); 162 163 protected: 164 friend class AccessConfig; 165 TaskPolicyConfig m_Policy; 166 private: 167 }; 168 169 } 170 } 171 172 #endif 173 174 #endif /* NN_BOSS_BOSS_TASK_POLICY_H_ */ 175