1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: dlp_FakeClient.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 14 *---------------------------------------------------------------------------*/ 15 #ifndef NN_DLP_CTR_DLP_FAKE_CLIENT_H_ 16 #define NN_DLP_CTR_DLP_FAKE_CLIENT_H_ 17 18 #include <nn/dlp/CTR/dlp_Type.h> 19 20 #ifdef __cplusplus 21 22 namespace nn { 23 namespace dlp { 24 namespace CTR { 25 26 /*!--------------------------------------------------------------------------* 27 @brief ダウンロードプレイの擬似クライアントのクラスです。 28 *--------------------------------------------------------------------------*/ 29 class FakeClient 30 { 31 private: FakeClient()32 FakeClient() {}; ~FakeClient()33 ~FakeClient() {}; 34 35 public: 36 /*!--------------------------------------------------------------------------* 37 @brief 擬似クライアントの初期化に必要なバッファのサイズを取得します。 38 39 @param[in] scanNum 一度のスキャン要求で受信可能なタイトル数を指定します。最大で MAX_SCAN_NUM です。 40 41 @return バッファのサイズを返します。 42 43 *--------------------------------------------------------------------------*/ 44 static size_t GetBufferSize(u8 scanNum); 45 46 47 /*!--------------------------------------------------------------------------* 48 @brief 擬似クライアントを初期化します。 49 50 pBuffer に GetBufferSize() で指定されたサイズの 4096 Byte 境界 のバッファを指定してください。バッファにデバイスメモリを使用しないでください。 51 52 @param[in] scanNum 一度のスキャン要求で受信可能なタイトル数を指定します。最大で MAX_SCAN_NUM です。 53 @param[in] eventHandle ダウンロードプレイからのシグナルを待つ nn::os::Event のハンドルを指定します。 Event はアプリケーションで初期化してください。また、イベントの情報は GetEventDesc で取得します。 54 @param[in] pBuffer DLP の作業バッファへのポインタ。4096 バイト境界にしてください。 55 @param[in] bufferSize 作業バッファのサイズ。4096 バイト境界にしてください。 56 57 @return 処理の結果として以下の Result が返ってきます。 58 @retval ResultSuccess 初期化に成功しました。 59 @retval ResultInvalidPointer pBuffer が NULL か 4096 バイト境界でないです。 60 @retval ResultOutOfRange scanNum あるいは bufferSize が不正です。 61 @retval ResultInvalidHandle eventHandle が不正です。 62 @retval ResultAlreadyOccupiedWirelessDevice 無線デバイスが既に他の用途で占有されています。 他の無線処理を終了してください。 63 @retval ResultWirelessOff 通信できない状態(スリープあるいは Wifi ボタンが OFF)です。 64 @retval ResultInternalError 内部に回復不可のエラーが発生しました。 65 66 *--------------------------------------------------------------------------*/ 67 static nn::Result Initialize(u8 scanNum, nn::Handle eventHandle, void* pBuffer, const size_t bufferSize); 68 69 70 /*!--------------------------------------------------------------------------* 71 @brief 疑似クライアントを終了します。 72 73 @return 処理の結果が返ってきます。 74 @retval ResultSuccess 終了が成功しました。 75 76 *--------------------------------------------------------------------------*/ 77 static nn::Result Finalize(); 78 79 80 /*!--------------------------------------------------------------------------* 81 @brief 到着しているイベントをキューから取得します。 82 83 現在のキューのサイズはイベント32個分です。キューがいっぱいになると、古いイベントから消去され新しいイベントが追加されます。<BR> 84 イベントがない場合、本API はブロックせず ResultNoData() の返すエラーコードを 返します。<BR> 85 なお、 イベントを取得しなくても各種状態取得 API を利用すれば処理を行えます。 86 87 @param[out] pEventDesc イベントを読み込み先を指定します。 88 89 @return 処理の結果として以下の Result が返ってきます。 90 @retval ResultSuccess イベントの取得が成功しました。 91 @retval ResultNoData イベントがありません。 92 *--------------------------------------------------------------------------*/ 93 static nn::Result GetEventDesc(EventDesc* pEventDesc); 94 95 96 /*!--------------------------------------------------------------------------* 97 @brief スキャンで使用できるチャンネルのビットマップを返します。 98 99 @param[out] pChannels チャンネルのビットマップを返します。 最下位 bit が 1ch になります。 100 101 @return 処理の結果として以下の Result が返ってきます。 102 @retval ResultSuccess チャンネルのビットマップの取得が成功しました。 103 104 *--------------------------------------------------------------------------*/ 105 static nn::Result GetChannels(bit16* pChannels); 106 107 108 /*!--------------------------------------------------------------------------* 109 @brief サーバのスキャンを開始します。 110 111 前回のスキャン結果をクリアしてスキャンを行います。 StopScan() が呼ばれるまでスキャンを行います。<BR> 112 スキャン中も GetServerInfo()、GetTitleInfo() でスキャン結果を取得できます。 113 114 @param[in] channels スキャンするチャンネルをビットマップで指定します。スキャンできるチャンネルは GetChannels() で取得してください。 115 @param[in] uniqueId スキャン結果を絞り込む Unique ID を指定します。 0 を指定すると絞込みを行いません。 116 @param[in] childIndex スキャン結果を絞り込む childIndex を指定します。 UniqueId が 0 のときは無効です。 117 @param[in] pMac スキャン結果を絞り込むサーバの MAC アドレスを指定します。 NULL を指定すると MAC ID で絞込みを行いません。 118 119 @return 処理の結果として以下の Result が返ってきます。 120 @retval ResultSuccess スキャンの開始が成功しました。 121 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_DISCONNECTED_NETWORK で使用してください。 122 @retval ResultOutOfRange channels の値が不正です。 123 124 *--------------------------------------------------------------------------*/ 125 static nn::Result StartScan(bit16 channels, u32 uniqueId = 0, u8 childIndex = 0, const u8* pMac = NULL); 126 127 128 /*!--------------------------------------------------------------------------* 129 @brief サーバのスキャンを停止します。 130 131 スキャン結果は StartScan() を呼ぶまで保持されています。 132 133 @return 処理の結果として以下の Result が返ってきます。 134 @retval ResultSuccess スキャンの停止が成功しました。 135 136 *--------------------------------------------------------------------------*/ 137 static nn::Result StopScan(); 138 139 140 /*!--------------------------------------------------------------------------* 141 @brief スキャン結果からサーバ情報を取得します。 142 143 linkLevel、nodeNum、nodeInfo の動的に変化する情報はスキャン中(CLIENT_STATE_SCANNING)しか更新されません <BR> 144 サーバに接続している間(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)、これらの情報は GetConnectingNodes()、 <BR> 145 GetNodeInfo()、GetLinkLevel() で取得してください。 146 147 @param[out] pServerInfo サーバー情報を返します。 148 @param[in] pMac サーバの MAC アドレスを指定します。 149 150 @return 処理の結果として以下の Result が返ってきます。 151 @retval ResultSuccess サーバの情報の取得が成功しました。 152 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_INVALID、CLIENT_STATE_ERROR では使用しないでください。 153 @retval ResultNoData 指定された MAC アドレスのサーバがありません。 154 155 *--------------------------------------------------------------------------*/ 156 static nn::Result GetServerInfo(ServerInfo* pServerInfo, const u8* pMac); 157 158 159 /*!--------------------------------------------------------------------------* 160 @brief スキャン結果からタイトル情報を取得します。 161 162 @param[out] pTitleInfo タイトルの情報を返します。 163 @param[in] pMac タイトルを配信しているサーバの MAC アドレスを指定します。 164 @param[in] uniqueId タイトルの Unique ID を指定します。 165 @param[in] childIndex タイトルの childIndex を指定します。 166 167 @return 処理の結果として以下の Result が返ってきます。 168 @retval ResultSuccess タイトル情報の取得が成功しました。 169 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_INVALID、CLIENT_STATE_ERROR では使用しないでください。 170 @retval ResultNoData 指定された MAC アドレス、 Unique ID、Child index のタイトルがありません。 171 172 *--------------------------------------------------------------------------*/ 173 static nn::Result GetTitleInfo(TitleInfo* pTitleInfo, const u8* pMac, u32 uniqueId, u8 childIndex); 174 175 176 /*!--------------------------------------------------------------------------* 177 @brief スキャン結果からタイトル情報を取得します。 178 179 先頭から順にタイトルの情報を取得します。取得の際にリストの末尾に到達しているかタイトルの情報がない場合<BR> 180 ブロックせずに ResultNoData を返します。<BR> 181 (スキャン中は新しくタイトルを発見するとリストの最後尾にタイトル情報が追加されます。)<BR> 182 先頭を取得する場合は、isReset を true にします。 183 184 @param[out] pTitleInfo タイトルの情報を返します。 185 @param[in] isReset 先頭を取得する場合、 true にします。 186 187 @return 処理の結果として以下の Result が返ってきます。 188 @retval ResultSuccess タイトル情報の取得が成功しました。 189 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_INVALID、CLIENT_STATE_ERROR では使用しないでください。 190 @retval ResultNoData スキャン結果のリストが空か、リストの末尾に到達しています。 191 192 *--------------------------------------------------------------------------*/ 193 static nn::Result GetTitleInfo(TitleInfo* pTitleInfo, bool isReset = false); 194 195 196 /*!--------------------------------------------------------------------------* 197 @brief 指定されたサーバのスキャン情報(サーバ情報とタイトル情報)をスキャン結果から削除します。 198 199 @param[in] pMac スキャン情報を削除するサーバの MAC アドレスを指定します。 200 201 @return 処理の結果として以下の Result が返ってきます。 202 @retval ResultSuccess スキャン情報の削除に成功しました。 203 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_DISCONNECTED_NETWORK か CLIENT_STATE_SCANNING で使用してください。 204 @retval ResultNoData 指定されたサーバは存在しません。 205 206 *--------------------------------------------------------------------------*/ 207 static nn::Result DeleteScanInfo(const u8* pMac); 208 209 210 /*!--------------------------------------------------------------------------* 211 @brief ダウンロードセッションへダウンロードなしで参加します。 212 213 @param[in] pMac 参加するセッションを持つサーバの MAC アドレスを指定します。 214 @param[in] uniqueId タイトルの Unique ID を指定します。 215 @param[in] childIndex タイトルの childIndex を指定します。 216 217 @return 処理の結果として以下の Result が返ってきます。 218 @retval ResultSuccess ダウンロードセッションへの参加が成功しました。 219 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_DISCONNECTED_NETWORK 状態で使用してください。 220 @retval ResultNoData 指定された MAC アドレス、Unique ID、Child index のタイトルがありません。 221 @retval ResultWirelessOff 通信できない状態(スリープあるいは Wifi ボタンが OFF)です。 222 @retval ResultNotFoundServer 接続対象のサーバが見つかりませんでした。 223 @retval ResultServerIsFull サーバのクライアント数が最大接続数に達していました。クライアント数が減少しない限り接続できません。 224 @retval ResultDeniedFromServer サーバに接続を拒否されました。 225 @retval ResultConnectionTimeout 一定時間以内に接続が成立しませんでした。電波状況が悪い場合や、通信過負荷時に返ります。 226 @retval ResultInternalError システム内で不整合が起きました。 227 228 *--------------------------------------------------------------------------*/ 229 static nn::Result StartFakeSession(const u8* pMac, u32 uniqueId, u8 childIndex); 230 231 232 /*!--------------------------------------------------------------------------* 233 @brief 参加中のセッションを終了します。 234 235 @return 処理の結果として以下の Result が返ってきます。 236 @retval ResultSuccess セッションの終了が成功しました。 237 238 *--------------------------------------------------------------------------*/ 239 static nn::Result StopFakeSession(); 240 241 242 /*!--------------------------------------------------------------------------* 243 @brief 自身の状態、ダウンロードの進捗などを取得します。 244 245 @param[out] pStatus 状態、ダウンロードの進捗などを返します。 246 247 @return 処理の結果として以下の Result が返ってきます。 248 @retval ResultSuccess 状態の取得が成功しました。 249 250 *--------------------------------------------------------------------------*/ 251 static nn::Result GetMyStatus(ClientStatus* pStatus); 252 253 254 /*!--------------------------------------------------------------------------* 255 @brief ネットワークに接続中のノードIDを取得します。 256 257 @param[out] pNum pNodeIds に格納されたノード ID の数を返します。 258 @param[out] pNodeIds ノードIDを返します。 259 @param[in] size pNodeIds の配列の個数を指定します。 260 261 @return 処理の結果として以下の Result が返ってきます。 262 @retval ResultSuccess ノード ID の取得が成功しました。 263 @retval ResultInvalidState 状態が不正です。サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 264 265 *--------------------------------------------------------------------------*/ 266 static nn::Result GetConnectingNodes(u8* pNum, u16* pNodeIds, u16 size); 267 268 269 /*!--------------------------------------------------------------------------* 270 @brief ネットワークに接続しているノードの情報を取得します。 271 272 @param[out] pNodeInfo ノードの情報を返します。 273 @param[in] nodeId ノードIDを指定します。 274 275 @return 処理の結果として以下の Result が返ってきます。 276 @retval ResultSuccess ノード情報の取得が成功しました。 277 @retval ResultInvalidState 状態が不正です。サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 278 @retval ResultNoData 指定されたノード ID のノードがありません。 279 280 *--------------------------------------------------------------------------*/ 281 static nn::Result GetNodeInfo(NodeInfo* pNodeInfo, u16 nodeId); 282 283 284 /*!--------------------------------------------------------------------------* 285 @brief リンクレベルを取得します。 286 287 @param[out] pLinkLevel リンクレベルを返します。 288 289 @return 処理の結果として以下の Result が返ってきます。 290 @retval ResultSuccess リンクレベルの取得が成功しました。 291 292 *--------------------------------------------------------------------------*/ 293 static nn::Result GetLinkLevel(nn::uds::LinkLevel* pLinkLevel); 294 295 296 }; 297 298 } // namespace CTR 299 } // namespace dlp 300 } // namespace nn 301 302 #endif // __cplusplus 303 #endif // ifndef NN_DLP_CTR_DLP_FAKE_CLIENT_H_ 304