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