/*---------------------------------------------------------------------------* 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 処理の結果が返ってきます。 *--------------------------------------------------------------------------*/ static nn::Result Initialize(u8 scanNum, nn::Handle eventHandle, void* pBuffer, const size_t bufferSize); /*!--------------------------------------------------------------------------* @brief クライアントを終了します。 @return 処理の結果が返ってきます。 *--------------------------------------------------------------------------*/ static nn::Result Finalize(); /*!--------------------------------------------------------------------------* @brief 到着しているイベントをキューから取得します。 現在のキューのサイズはイベント32個分です。キューがいっぱいになると、古いイベントから消去され新しいイベントが追加されます。
イベントがない場合、本API はブロックせず ResultNoData() の返すエラーコードを 返します。
なお、 イベントを取得しなくても各種状態取得 API を利用すれば処理を行えます。 @param[out] pEventDesc イベントを読み込み先を指定します。 @return イベントの読み込み結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetEventDesc(EventDesc* pEventDesc); /*!--------------------------------------------------------------------------* @brief スキャンで使用できるチャンネルのビットマップを返します。 @param[out] pChannels チャンネルのビットマップを返します。 最下位 bit が 1ch になります。 @return 処理の結果が返ってきます。 *--------------------------------------------------------------------------*/ static nn::Result GetChannels(bit16* pChannels); /*!--------------------------------------------------------------------------* @brief サーバのスキャンを開始します。 前回のスキャン結果をクリアしてスキャンを行います。 StopScan() が呼ばれるまでスキャンを行います。
スキャン中も GetServerInfo()、GetTitleInfo() でスキャン結果を取得できます。 @param[in] channels スキャンするチャンネルをビットマップで指定します。スキャンできるチャンネルは GetChannels() で取得してください。 @param[in] programId スキャン結果を絞り込むプログラムID を指定します。 0 を指定すると プログラム ID で絞込みを行いません。 @param[in] pMac スキャン結果を絞り込むサーバの MAC アドレスを指定します。 NULL を指定すると MAC ID で絞込みを行いません。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result StartScan(bit16 channels, nn::ProgramId programId = 0, const u8* pMac = NULL); /*!--------------------------------------------------------------------------* @brief サーバのスキャンを停止します。 スキャン結果は StartScan() を呼ぶまで保持されています。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ 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 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetServerInfo(ServerInfo* pServerInfo, const u8* pMac); /*!--------------------------------------------------------------------------* @brief スキャン結果からタイトル情報を取得します。 @param[out] pTitleInfo タイトルの情報を返します。 @param[in] pMac タイトルを配信しているサーバの MAC アドレスを指定します。 @param[in] programId タイトルのプログラム ID を指定します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetTitleInfo(TitleInfo* pTitleInfo, const u8* pMac, nn::ProgramId programId); /*!--------------------------------------------------------------------------* @brief スキャン結果のリストからタイトル情報を取得します。 先頭から順にタイトルの情報を取得します。取得の際にリストの末尾に到達しているかタイトルの情報がない場合
ブロックせずに ResultNoData() の返すエラーコードを返します。
ただし、スキャン中の場合は新しくタイトルを発見するとリストの最後尾にタイトル情報が追加されます。
先頭を取得する場合は、isReset を true にします。 @param[out] pTitleInfo タイトルの情報を返します。 @param[in] isReset 先頭を取得する場合、 true にします。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetTitleInfo(TitleInfo* pTitleInfo, bool isReset = false); /*!--------------------------------------------------------------------------* @brief ダウンロードセッションへダウンロードなしで参加します。 @param[in] pMac 参加するセッションを持つサーバの MAC アドレスを指定します。 @param[in] programId セッションに参加するタイトルのプログラムIDを指定します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result StartFakeSession(const u8* pMac, nn::ProgramId programId); /*!--------------------------------------------------------------------------* @brief 参加中のセッションを終了します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result StopFakeSession(); /*!--------------------------------------------------------------------------* @brief 自身の状態を取得します。 @param[out] pStatus 状態、ダウンロードの進捗などを返します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetMyStatus(ClientStatus* pStatus); /*!--------------------------------------------------------------------------* @brief 接続中のノードIDを取得します。 本 API は、 サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 @param[out] pNum pNodeIds に格納されたノード ID の数を返します。 @param[out] pNodeIds ノードIDを返します。 @param[in] size pNodeIds の配列の個数を指定します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetConnectingNodes(u8* pNum, u16* pNodeIds, u16 size); /*!--------------------------------------------------------------------------* @brief 接続しているノードの情報を取得します。 本 API は、 サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 @param[out] pNodeInfo ノードの情報を返します。 @param[in] nodeId ノードIDを指定します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ static nn::Result GetNodeInfo(NodeInfo* pNodeInfo, u16 nodeId); /*!--------------------------------------------------------------------------* @brief リンクレベルを取得します。 本 API は、 サーバに接続している状態(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING)で使用してください。 @param[out] pLinkLevel リンクレベルを返します。 @return 処理結果を返します。 *--------------------------------------------------------------------------*/ 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_