/*---------------------------------------------------------------------------* Project: Horizon File: dlp_FakeClient.h Copyright (C)2009 Nintendo Co., Ltd. All rights reserved. These coded instructions, statements, and computer programs contain proprietary information of Nintendo of America Inc. and/or Nintendo Company Ltd., and are protected by Federal copyright law. They may not be disclosed to third parties or copied or duplicated in any form, in whole or in part, without the prior written consent of Nintendo. *---------------------------------------------------------------------------*/ #ifndef NN_DLP_CTR_DLP_FAKE_CLIENT_H_ #define NN_DLP_CTR_DLP_FAKE_CLIENT_H_ #include #ifdef __cplusplus namespace nn { namespace dlp { namespace CTR { /*!--------------------------------------------------------------------------* @brief ダウンロードプレイの擬似クライアントのクラスです。 *--------------------------------------------------------------------------*/ class FakeClient { private: FakeClient() {}; ~FakeClient() {}; public: /*!--------------------------------------------------------------------------* @brief 擬似クライアントの初期化に必要なバッファのサイズを取得します。 @param[in] scanNum 一度のスキャン要求で受信可能なタイトル数を指定します。最大で MAX_SCAN_NUM です。 @return バッファのサイズを返します。 *--------------------------------------------------------------------------*/ static size_t GetBufferSize(u8 scanNum); /*!--------------------------------------------------------------------------* @brief 擬似クライアントを初期化します。 pBuffer に GetBufferSize() で指定されたサイズの 4096 Byte 境界 のバッファを指定してください。バッファにデバイスメモリを使用しないでください。 @param[in] scanNum 一度のスキャン要求で受信可能なタイトル数を指定します。最大で MAX_SCAN_NUM です。 @param[in] eventHandle ダウンロードプレイからのシグナルを待つ nn::os::Event のハンドルを指定します。 Event はアプリケーションで初期化してください。また、イベントの情報は GetEventDesc で取得します。 @param[in] pBuffer DLP の作業バッファへのポインタ。4096 バイト境界にしてください。 @param[in] bufferSize 作業バッファのサイズ。4096 バイト境界にしてください。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess 初期化に成功しました。 @retval ResultInvalidPointer pBuffer が NULL か 4096 バイト境界でないです。 @retval ResultOutOfRange scanNum あるいは bufferSize が不正です。 @retval ResultInvalidHandle eventHandle が不正です。 @retval ResultAlreadyOccupiedWirelessDevice 無線デバイスが既に他の用途で占有されています。 他の無線処理を終了してください。 @retval ResultWirelessOff 通信できない状態(スリープあるいは Wifi ボタンが OFF)です。 @retval ResultInternalError 内部に回復不可のエラーが発生しました。 *--------------------------------------------------------------------------*/ static nn::Result Initialize(u8 scanNum, nn::Handle eventHandle, void* pBuffer, const size_t bufferSize); /*!--------------------------------------------------------------------------* @brief 疑似クライアントを終了します。 @return 処理の結果が返ってきます。 @retval ResultSuccess 終了が成功しました。 *--------------------------------------------------------------------------*/ static nn::Result Finalize(); /*!--------------------------------------------------------------------------* @brief 到着しているイベントをキューから取得します。 現在のキューのサイズはイベント32個分です。キューがいっぱいになると、古いイベントから消去され新しいイベントが追加されます。
イベントがない場合、本API はブロックせず ResultNoData() の返すエラーコードを 返します。
なお、 イベントを取得しなくても各種状態取得 API を利用すれば処理を行えます。 @param[out] pEventDesc イベントを読み込み先を指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess イベントの取得が成功しました。 @retval ResultNoData イベントがありません。 *--------------------------------------------------------------------------*/ static nn::Result GetEventDesc(EventDesc* pEventDesc); /*!--------------------------------------------------------------------------* @brief スキャンで使用できるチャンネルのビットマップを返します。 @param[out] pChannels チャンネルのビットマップを返します。 最下位 bit が 1ch になります。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess チャンネルのビットマップの取得が成功しました。 *--------------------------------------------------------------------------*/ static nn::Result GetChannels(bit16* pChannels); /*!--------------------------------------------------------------------------* @brief サーバのスキャンを開始します。 前回のスキャン結果をクリアしてスキャンを行います。 StopScan() が呼ばれるまでスキャンを行います。
スキャン中も GetServerInfo()、GetTitleInfo() でスキャン結果を取得できます。 @param[in] channels スキャンするチャンネルをビットマップで指定します。スキャンできるチャンネルは GetChannels() で取得してください。 @param[in] uniqueId スキャン結果を絞り込む Unique ID を指定します。 0 を指定すると絞込みを行いません。 @param[in] childIndex スキャン結果を絞り込む childIndex を指定します。 UniqueId が 0 のときは無効です。 @param[in] pMac スキャン結果を絞り込むサーバの MAC アドレスを指定します。 NULL を指定すると MAC ID で絞込みを行いません。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess スキャンの開始が成功しました。 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_DISCONNECTED_NETWORK で使用してください。 @retval ResultOutOfRange channels の値が不正です。 *--------------------------------------------------------------------------*/ static nn::Result StartScan(bit16 channels, u32 uniqueId = 0, u8 childIndex = 0, const u8* pMac = NULL); /*!--------------------------------------------------------------------------* @brief サーバのスキャンを停止します。 スキャン結果は StartScan() を呼ぶまで保持されています。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess スキャンの停止が成功しました。 *--------------------------------------------------------------------------*/ static nn::Result StopScan(); /*!--------------------------------------------------------------------------* @brief スキャン結果からサーバ情報を取得します。 linkLevel、nodeNum、nodeInfo の動的に変化する情報はスキャン中(CLIENT_STATE_SCANNING)しか更新されません
サーバに接続している間(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)、これらの情報は GetConnectingNodes()、
GetNodeInfo()、GetLinkLevel() で取得してください。 @param[out] pServerInfo サーバー情報を返します。 @param[in] pMac サーバの MAC アドレスを指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess サーバの情報の取得が成功しました。 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_INVALID、CLIENT_STATE_ERROR では使用しないでください。 @retval ResultNoData 指定された MAC アドレスのサーバがありません。 *--------------------------------------------------------------------------*/ static nn::Result GetServerInfo(ServerInfo* pServerInfo, const u8* pMac); /*!--------------------------------------------------------------------------* @brief スキャン結果からタイトル情報を取得します。 @param[out] pTitleInfo タイトルの情報を返します。 @param[in] pMac タイトルを配信しているサーバの MAC アドレスを指定します。 @param[in] uniqueId タイトルの Unique ID を指定します。 @param[in] childIndex タイトルの childIndex を指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess タイトル情報の取得が成功しました。 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_INVALID、CLIENT_STATE_ERROR では使用しないでください。 @retval ResultNoData 指定された MAC アドレス、 Unique ID、Child index のタイトルがありません。 *--------------------------------------------------------------------------*/ static nn::Result GetTitleInfo(TitleInfo* pTitleInfo, const u8* pMac, u32 uniqueId, u8 childIndex); /*!--------------------------------------------------------------------------* @brief スキャン結果からタイトル情報を取得します。 先頭から順にタイトルの情報を取得します。取得の際にリストの末尾に到達しているかタイトルの情報がない場合
ブロックせずに ResultNoData を返します。
(スキャン中は新しくタイトルを発見するとリストの最後尾にタイトル情報が追加されます。)
先頭を取得する場合は、isReset を true にします。 @param[out] pTitleInfo タイトルの情報を返します。 @param[in] isReset 先頭を取得する場合、 true にします。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess タイトル情報の取得が成功しました。 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_INVALID、CLIENT_STATE_ERROR では使用しないでください。 @retval ResultNoData スキャン結果のリストが空か、リストの末尾に到達しています。 *--------------------------------------------------------------------------*/ static nn::Result GetTitleInfo(TitleInfo* pTitleInfo, bool isReset = false); /*!--------------------------------------------------------------------------* @brief 指定されたサーバのスキャン情報(サーバ情報とタイトル情報)をスキャン結果から削除します。 @param[in] pMac スキャン情報を削除するサーバの MAC アドレスを指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess スキャン情報の削除に成功しました。 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_DISCONNECTED_NETWORK か CLIENT_STATE_SCANNING で使用してください。 @retval ResultNoData 指定されたサーバは存在しません。 *--------------------------------------------------------------------------*/ static nn::Result DeleteScanInfo(const u8* pMac); /*!--------------------------------------------------------------------------* @brief ダウンロードセッションへダウンロードなしで参加します。 @param[in] pMac 参加するセッションを持つサーバの MAC アドレスを指定します。 @param[in] uniqueId タイトルの Unique ID を指定します。 @param[in] childIndex タイトルの childIndex を指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess ダウンロードセッションへの参加が成功しました。 @retval ResultInvalidState 状態が不正です。 CLIENT_STATE_DISCONNECTED_NETWORK 状態で使用してください。 @retval ResultNoData 指定された MAC アドレス、Unique ID、Child index のタイトルがありません。 @retval ResultWirelessOff 通信できない状態(スリープあるいは Wifi ボタンが OFF)です。 @retval ResultNotFoundServer 接続対象のサーバが見つかりませんでした。 @retval ResultServerIsFull サーバのクライアント数が最大接続数に達していました。クライアント数が減少しない限り接続できません。 @retval ResultDeniedFromServer サーバに接続を拒否されました。 @retval ResultConnectionTimeout 一定時間以内に接続が成立しませんでした。電波状況が悪い場合や、通信過負荷時に返ります。 @retval ResultInternalError システム内で不整合が起きました。 *--------------------------------------------------------------------------*/ static nn::Result StartFakeSession(const u8* pMac, u32 uniqueId, u8 childIndex); /*!--------------------------------------------------------------------------* @brief 参加中のセッションを終了します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess セッションの終了が成功しました。 *--------------------------------------------------------------------------*/ static nn::Result StopFakeSession(); /*!--------------------------------------------------------------------------* @brief 自身の状態、ダウンロードの進捗などを取得します。 @param[out] pStatus 状態、ダウンロードの進捗などを返します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess 状態の取得が成功しました。 *--------------------------------------------------------------------------*/ static nn::Result GetMyStatus(ClientStatus* pStatus); /*!--------------------------------------------------------------------------* @brief ネットワークに接続中のノードIDを取得します。 @param[out] pNum pNodeIds に格納されたノード ID の数を返します。 @param[out] pNodeIds ノードIDを返します。 @param[in] size pNodeIds の配列の個数を指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess ノード ID の取得が成功しました。 @retval ResultInvalidState 状態が不正です。サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 *--------------------------------------------------------------------------*/ static nn::Result GetConnectingNodes(u8* pNum, u16* pNodeIds, u16 size); /*!--------------------------------------------------------------------------* @brief ネットワークに接続しているノードの情報を取得します。 @param[out] pNodeInfo ノードの情報を返します。 @param[in] nodeId ノードIDを指定します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess ノード情報の取得が成功しました。 @retval ResultInvalidState 状態が不正です。サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 @retval ResultNoData 指定されたノード ID のノードがありません。 *--------------------------------------------------------------------------*/ static nn::Result GetNodeInfo(NodeInfo* pNodeInfo, u16 nodeId); /*!--------------------------------------------------------------------------* @brief リンクレベルを取得します。 @param[out] pLinkLevel リンクレベルを返します。 @return 処理の結果として以下の Result が返ってきます。 @retval ResultSuccess リンクレベルの取得が成功しました。 *--------------------------------------------------------------------------*/ static nn::Result GetLinkLevel(nn::uds::LinkLevel* pLinkLevel); }; } // namespace CTR } // namespace dlp } // namespace nn #endif // __cplusplus #endif // ifndef NN_DLP_CTR_DLP_FAKE_CLIENT_H_