1 /*---------------------------------------------------------------------------* 2 3 Copyright (C) 2012 Nintendo. All rights reserved. 4 5 These coded instructions, statements, and computer programs contain 6 proprietary information of Nintendo of America Inc. and/or Nintendo 7 Company Ltd., and are protected by Federal copyright law. They may 8 not be disclosed to third parties or copied or duplicated in any form, 9 in whole or in part, without the prior written consent of Nintendo. 10 11 *---------------------------------------------------------------------------*/ 12 13 #ifndef NN_AC_H_ 14 #define NN_AC_H_ 15 16 /*! 17 @defgroup nn_ac Automatic Connection (AC) Library 18 @brief This module controls automatic network connections. 19 20 The AC library provides APIs for network connections. 21 It provides easier-to-use wrappers for the functions of the NC library. 22 The NC library is private as of SDK 2.06. 23 NC library calls cannot be included in retail version code. 24 25 26 As its name implies, AC provides functionality for automatic connection to the network. 27 When the profile specified in System Settings can connect, having the system connect automatically reduces the amount of time an application takes to connect using <tt>nn::ac::Connect</tt> or <tt>nn::ac::ConnectAsync</tt>. 28 29 When you are disconnected from the network for an external reason, having the system attempt to connect periodically improves performance during recovery. 30 31 Note that the AC library only connects automatically to the default profile. It does not automatically select the profile to connect to from all those available. 32 33 34 <b>The AC API functions that can be used in general applications are contained in <tt>ac_Api.h</tt>. 35 Use of the API functions in <tt>ac_ApiDebug.h</tt> and <tt>ac_Config.h</tt> is permitted during development, but they must not be included in retail versions. </b> 36 37 38 In retail versions, either include <tt>ac.h</tt>, or include only <tt>ac_Types.h</tt>, <tt>ac_Result.h</tt>, and <tt>ac_Api.h</tt> (included in <tt>ac.h</tt>). 39 40 If retail version builds produce errors if <tt>ac_ApiDebug.h</tt> or <tt>ac_Config.h</tt> is not included, it could be because unauthorized functions are being used. 41 42 As long as only permitted functions are used in retail versions, it should not be necessary to access <tt>ac_TypesDebug.h</tt>, <tt>ac_DetailedErrorCode.h</tt>, or <tt>ac_TypesConfig.h</tt>, where structures and constants are defined. Because these are simple definitions, the risk of using them in retail versions is low. 43 These files may be accessed if necessary. 44 45 For more information about the AC library, see the API Reference and the sample demos. 46 For information about C functions, see <tt>@ref nn_ac_api_c</tt>. For information about C++ API functions, see <tt>@ref nn_ac_api_cpp</tt>. 47 48 @{ 49 50 51 52 53 54 55 56 */ 57 58 /*! 59 @namespace nn::ac 60 @brief Namespace for the Automatic Connection (AC) Library. 61 62 @defgroup nn_ac_result Automatic Connection (AC) Results 63 @brief A list of <tt>Results</tt> used in the Automatic Connection (AC) library. 64 */ 65 66 /*! 67 @} 68 */ 69 70 #include <nn/ac/ac_Types.h> 71 #include <nn/ac/ac_Result.h> 72 #include <nn/ac/ac_Api.h> 73 74 75 #endif // NN_AC_H_ 76