CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
pia_Debug.h
1 /*--------------------------------------------------------------------------------*
2  Copyright (C)Nintendo All rights reserved.
3 
4  These coded instructions, statements, and computer programs contain proprietary
5  information of Nintendo and/or its licensed developers and are protected by
6  national and international copyright laws. They may not be disclosed to third
7  parties or copied or duplicated in any form, in whole or in part, without the
8  prior written consent of Nintendo.
9 
10  The content herein is highly confidential and should be handled accordingly.
11  *--------------------------------------------------------------------------------*/
12 
13 
14 #pragma once
15 
16 #include <nn/pia/pia_Definitions.h>
17 
18 namespace nn
19 {
20 namespace pia
21 {
22 /*!
23  @cond PRIVATE
24  @brief デバッグ用の機能を扱うクラスです。
25  */
26 class Debug
27 {
28 #if NN_PIA_CAFE
29 public:
30  /*!
31  @brief ネットワークインターフェースを停止します。
32  @details 本 API は、通信時にネットワークインターフェースが異常切断された場合の
33  ハンドリングをデバッグするために使用してください。
34 
35  ネットワークインターフェースを停止した場合、自動的に再起動されます。
36  しかしながら、停止時に通信関係のライブラリは継続して動作できない状態に陥るため、
37  再起動後にそれらライブラリの再起動も必要になりますので、注意してください。
38  */
39  static void ControlNetworkIfDown();
40 #elif NN_PIA_NINTENDOSDK
41 public:
42  /*!
43  @cond PRIVATE
44  @brief ネットワークインターフェースの種類
45  */
46  enum NetworkInterfaceType
47  {
48  NetworkInterfaceType_Invalid = 0,
49  NetworkInterfaceType_Ieee80211,
50  NetworkInterfaceType_Ethernet
51  };
52  //! @endcond
53 
54  /*!
55  @cond PRIVATE
56  @brief (デバッグ用)ネットワークインターフェースを停止します。
57  @details 本 API は、通信時にネットワークインターフェースが異常切断された場合のハンドリングをデバッグするために使用してください。
58  @param[in] type 停止するネットワークインターフェースの種類
59  */
60  static void NetworkInterfaceDown(NetworkInterfaceType type);
61  //! @endcond
62 
63  /*!
64  @cond PRIVATE
65  @brief (デバッグ用)ネットワークインターフェースを起動します。
66  @details 本 API は、通信時にネットワークインターフェースを異常切断した後、復帰させるために使用してください。
67  @param[in] type 起動するネットワークインターフェースの種類
68  */
69  static void NetworkInterfaceUp(NetworkInterfaceType type);
70  //! @endcond
71 
72  /*!
73  @cond PRIVATE
74  @brief (デバッグ用)ネットワークインターフェースの起動状態を取得します。
75  @param[in] type 起動状態を取得するネットワークインターフェースの種類
76  @return ネットワークインターフェースの起動状態を返します。起動状態の場合は true を返します。
77  */
78  static bool IsNetworkInterfaceUp(NetworkInterfaceType type);
79  //! @endcond
80 
81 private:
82  static void ControlNetworkInterface(NetworkInterfaceType type, bool isEnabled);
83 #endif
84 };
85 //! @endcond
86 }
87 } // end of namespace nn::pia