/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     ac_Result.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.

  $Rev: 31953 $
 *---------------------------------------------------------------------------*/

#ifndef NN_AC_AC_RESULT_H_
#define NN_AC_AC_RESULT_H_

#include <nn/Result.h>

#ifdef __cplusplus

namespace nn { namespace ac {
//新しい定義

    /*
        @brief Result コードの詳細
    */
    enum Description
    {
        DESCRIPTION_WAN_CONNECTED = 50,                   //!< WAN接続中
        DESCRIPTION_LAN_CONNECTED,                        //!< LAN接続中
        DESCRIPTION_UNNECESSARY_HOTSPOT_LOGOUT,           //!< ホットスポット認証ログアウト不要

        DESCRIPTION_PROCESSING = 70,                      //!< 接続処理中

        DESCRIPTION_FAILED_STARTUP = 100,                 //!< 無線デバイスの初期化に失敗
        DESCRIPTION_FAILED_CONNECT_AP,                    //!< アクセスポイントへの接続に失敗
        DESCRIPTION_FAILED_DHCP,                          //!< IPアドレスの取得に失敗
        DESCRIPTION_CONFLICT_IP_ADDRESS,                  //!< IPアドレスが衝突
        DESCRIPTION_INVALID_KEY_VALUE,                    //!< 暗号化鍵間違え
        DESCRIPTION_UNSUPPORT_AUTH_ALGORITHM,             //!< 非対応の暗号化方式
        DESCRIPTION_DENY_USB_AP,                          //!< ニンテンドーWi-Fi USBコネクタに接続を拒否された

        DESCRIPTION_INVALID_DNS = 150,                    //!< 名前解決に失敗
        DESCRIPTION_INVALID_PROXY,                        //!< プロキシサーバへの接続に失敗
        DESCRIPTION_FAILED_CONNTEST,                      //!< HTTPサーバへの接続に失敗

        DESCRIPTION_UNSUPPORT_HOTSPOT = 200,              //!< 非対応のホットスポットからの接続
        DESCRIPTION_FAILED_HOTSPOT_AUTHENTICATION,        //!< ホットスポット認証に失敗
        DESCRIPTION_FAILED_HOTSPOT_CONNTEST,              //!< ホットスポット認証後のHTTPサーバへの接続に失敗
        DESCRIPTION_UNSUPPORT_PLACE,                      //!< アプリケーションのインターネット利用できない場所
        DESCRIPTION_FAILED_HOTSPOT_LOGOUT,                //!< ホットスポット認証ログアウトに失敗
        DESCRIPTION_ALREADY_CONNECT_UNSUPPORT_AP,         //!< 既に非対応のアクセスポイントに接続中

        DESCRIPTION_FAILED_SCAN = 300,                    //!< スキャンに失敗
        DESCRIPTION_ALREADY_CONNECTING,                   //!< 既に接続中
        DESCRIPTION_NOT_CONNECTING,                       //!< 接続していない
        DESCRIPTION_ALREADY_EXCLUSIVE,                    //!< 既に独占中
        DESCRIPTION_NOT_EXCLUSIVE,                        //!< 独占していない
        DESCRIPTION_INVALID_LOCATION,                     //!< 不正な場所

        DESCRIPTION_NOT_AGREE_EULA = 900,                 //!< EULA非同意
        DESCRIPTION_WIFI_OFF,                             //!< 無線 OFF モード
        DESCRIPTION_BROKEN_NAND,                          //!< NANDデバイスが故障
        DESCRIPTION_BROKEN_WIRELESS,                      //!< 無線デバイスが故障

        DESCRIPTION_END
    };

    /*!
      @name   Result 値
      @{
    */

    /*!
        @class nn::ac::ResultDebugOnly
        @brief Debug / Development ビルドでしか利用できないAPIをReleaseビルドで呼び出した時に発生します。。
    */
        NN_DEFINE_RESULT_CONST(
                ResultDebugOnly,
            Result::LEVEL_USAGE, Result::SUMMARY_WOULD_BLOCK, Result::MODULE_NN_AC, Result::DESCRIPTION_NOT_IMPLEMENTED
        );

    /*!
        @class nn::ac::ResultAlreadyInitialized
        @brief 既に初期化済のプロセスに対して、多重で初期化しようとしたことを示します。
               初期化回数は参照カウントを持っていますので、初期化した回数だけ開放を呼び出してください。
    */
        NN_DEFINE_RESULT_CONST(
                ResultAlreadyInitialized,
            Result::LEVEL_SUCCESS, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_AC, Result::DESCRIPTION_ALREADY_INITIALIZED
        );

    /*!
        @class nn::ac::ResultNotInitialized
        @brief 既に開放済のプロセスに対して、多重で開放しようとしたことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultNotInitialized,
            Result::LEVEL_SUCCESS, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_AC, Result::DESCRIPTION_NOT_INITIALIZED
        );

    /*!
        @class nn::ac::ResultCanceled
        @brief 処理をキャンセルしたことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultCanceled,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, Result::DESCRIPTION_CANCEL_REQUESTED
        );

    /*!
        @class nn::ac::ResultInvalidData
        @brief 不正なデータだったことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultInvalidData,
            Result::LEVEL_USAGE, Result::SUMMARY_WOULD_BLOCK, Result::MODULE_NN_AC, Result::DESCRIPTION_INVALID_RESULT_VALUE
        );

    /*!
        @class nn::ac::ResultInvalidArgumentOutOfRange
        @brief 不正な範囲の引数を指定したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultInvalidArgumentOutOfRange,
            Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_AC, Result::DESCRIPTION_OUT_OF_RANGE
        );

    /*!
        @class nn::ac::ResultOutOfMemory
        @brief メモリが不足した為処理を継続できなかったことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultOutOfMemory,
            Result::LEVEL_FATAL, Result::SUMMARY_INTERNAL, Result::MODULE_NN_AC, Result::DESCRIPTION_OUT_OF_MEMORY
        );

    /*!
        @class nn::ac::ResultAlreadyExists
        @brief 非同期処理実行中に更に非同期処理を呼び出した時に、要求を継続できなかったことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultAlreadyExists,
            Result::LEVEL_USAGE, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, Result::DESCRIPTION_ALREADY_EXISTS
        );

    /*!
        @class nn::ac::ResultNotAgreeEula
        @brief EULA非同意によってキャンセルしたことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultNotAgreeEula,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_NOT_AGREE_EULA
        );

    /*!
        @class nn::ac::ResultWifiOff
        @brief 無線 OFF モードのため通信できなかったことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultWifiOff,
            Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, DESCRIPTION_WIFI_OFF
        );

    /*!
        :private
        @class nn::ac::ResultBrokenNand
        @brief NANDデバイスが故障している為、正常に動作できないことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultBrokenNand,
            Result::LEVEL_FATAL, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_AC, DESCRIPTION_BROKEN_NAND
        );

    /*!
        :private
        @class nn::ac::ResultBrokenWireless
        @brief 無線デバイスが故障している為、正常に動作できないことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultBrokenWireless,
            Result::LEVEL_FATAL, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_AC, DESCRIPTION_BROKEN_WIRELESS
        );

    /*!
        @class nn::ac::ResultNotFoundAccessPoint
        @brief @ref Connect / @ref ConnectAsync で接続しようとしたが、アクセスポイントが見つからなかったことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultNotFoundAccessPoint,
            Result::LEVEL_STATUS, Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_AC, Result::DESCRIPTION_NOT_FOUND
        );

    /*!
        @class nn::ac::ResultFailedStartup
        @brief 何らかの理由により、無線デバイスの初期化に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedStartup,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_STARTUP
        );

    /*!
        @class nn::ac::ResultFailedConnectAp
        @brief 何らかの理由により、アクセスポイントへの接続に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedConnectAp,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_CONNECT_AP
        );

    /*!
        @class nn::ac::ResultInvalidKeyValue
        @brief アクセスポイントに接続しようとしたが、暗号化鍵を間違えていることを示します。
               暗号化鍵を間違えた時に必ずこの Result が返る保障はありません。
    */
        NN_DEFINE_RESULT_CONST(
                ResultInvalidKeyValue,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_INVALID_KEY_VALUE
        );

    /*!
        @class nn::ac::ResultFailedDhcp
        @brief DHCPによるIPアドレス取得に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedDhcp,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_DHCP
        );

    /*!
        @class nn::ac::ResultConflictIpAddress
        @brief 取得したIPアドレスが衝突したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultConflictIpAddress,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_CONFLICT_IP_ADDRESS
        );

    /*!
        @class nn::ac::ResultUnsupportAuthAlgorithm
        @brief 非対応の暗号化方式のアクセスポイントに接続しようとしたことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultUnsupportAuthAlgorithm,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_UNSUPPORT_AUTH_ALGORITHM
        );

    /*!
        @class nn::ac::CTR::ResultDenyUsbAp
        @brief ニンテンドーWi-Fi USBコネクタに接続拒否されたことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultDenyUsbAp,
            Result::LEVEL_STATUS, Result::SUMMARY_INTERNAL, Result::MODULE_NN_AC, DESCRIPTION_DENY_USB_AP
        );

    /*!
        @class nn::ac::ResultInvalidDns
        @brief 名前解決に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultInvalidDns,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_INVALID_DNS
        );

    /*!
        @class nn::ac::ResultInvalidProxy
        @brief プロキシサーバへの接続に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultInvalidProxy,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_INVALID_PROXY
        );

    /*!
        @class nn::ac::ResultFailedConnTest
        @brief HTTPサーバへの接続に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedConnTest,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_CONNTEST
        );

    /*!
        @class nn::ac::ResultUnsupportHotspot
        @brief 非対応のホットスポットから接続しようとしたことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultUnsupportHotspot,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_UNSUPPORT_HOTSPOT
        );

    /*!
        @class nn::ac::ResultFailedHotspotAuthentication
        @brief ホットスポット認証に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedHotspotAuthentication,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_HOTSPOT_AUTHENTICATION
        );

    /*!
        @class nn::ac::ResultFailedHotspotConntest
        @brief ホットスポット認証後のHTTPサーバへの接続に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedHotspotConntest,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_HOTSPOT_CONNTEST
        );

    /*!
        :private
        @class nn::ac::ResultFailedHotspotLogout
        @brief ホットスポット認証ログアウトに失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedHotspotLogout,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_HOTSPOT_LOGOUT
        );

    /*!
        @class nn::ac::ResultUnsupportPlace
        @brief アプリケーションのインターネット利用できない場所で接続しようとして失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultUnsupportPlace,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_UNSUPPORT_PLACE
        );

    /*!
        :private
        @class nn::ac::ResultFailedHotspotLogout
        @brief ホットスポット認証ログアウトに失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedHotspotLogout,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_HOTSPOT_LOGOUT
        );

    /*!
        :private
        @class nn::ac::ResultAlreadyConnectUnsupportAp
        @brief 既に非対応のアクセスポイントに接続中のため、接続に失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultAlreadyConnectUnsupportAp,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_ALREADY_CONNECT_UNSUPPORT_AP
        );

    /*!
        @class nn::ac::ResultFailedScan
        @brief スキャンに失敗したことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultFailedScan,
            Result::LEVEL_STATUS, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_FAILED_SCAN
        );

    /*!
        @class nn::ac::ResultAlreadyConnecting
        @brief 接続しようとしたが、既に接続中である。もしくはキャンセルしようとしたが、既に接続済みだったことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultAlreadyConnecting,
            Result::LEVEL_USAGE, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, DESCRIPTION_ALREADY_CONNECTING
        );

    /*!
        @class nn::ac::ResultNotConnecting
        @brief 接続が完了していないことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultNotConnecting,
            Result::LEVEL_USAGE, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, DESCRIPTION_NOT_CONNECTING
        );

    /*!
        :private
        @class nn::ac::ResultAlreadyExclusive
        @brief 独占しようとしたが、既に独占中であることを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultAlreadyExclusive,
            Result::LEVEL_USAGE, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, DESCRIPTION_ALREADY_EXCLUSIVE
        );

    /*!
        :private
        @class nn::ac::ResultNotExclusive
        @brief 独占が完了していないことを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultNotExclusive,
            Result::LEVEL_USAGE, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, DESCRIPTION_NOT_EXCLUSIVE
        );

    /*!
        @class nn::ac::ResultInvalidLocation
        @brief 不正な場所での実行を示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultInvalidLocation,
            Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_AC, DESCRIPTION_INVALID_LOCATION
        );

    /*!
        @class nn::ac::ResultLanConnected
        @brief LANモードで接続中を示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultLanConnected,
            Result::LEVEL_SUCCESS, Result::SUMMARY_SUCCESS, Result::MODULE_NN_AC, DESCRIPTION_LAN_CONNECTED
        );

    /*!
        @class nn::ac::ResultWanConnected
        @brief WANモードで接続中を示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultWanConnected,
            Result::LEVEL_SUCCESS, Result::SUMMARY_SUCCESS, Result::MODULE_NN_AC, DESCRIPTION_WAN_CONNECTED
        );

    /*!
        :private
        @class nn::ac::ResultUnnecessaryHotspotLogout
        @brief ホットスポットログアウトが不要であることを示します。
    */
        NN_DEFINE_RESULT_CONST(
                ResultUnnecessaryHotspotLogout,
            Result::LEVEL_SUCCESS, Result::SUMMARY_SUCCESS, Result::MODULE_NN_AC, DESCRIPTION_UNNECESSARY_HOTSPOT_LOGOUT
        );

	/*!
		@class nn::ac::ResultProcessing
		@brief 処理中であることを示します。
	*/
		NN_DEFINE_RESULT_CONST(
				ResultProcessing,
			Result::LEVEL_USAGE, Result::SUMMARY_CANCELLED, Result::MODULE_NN_AC, DESCRIPTION_PROCESSING
		);

}}

#endif // __cplusplus

#endif