CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
session_Types.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/session/session_Definitions.h>
17 
18 namespace nn
19 {
20 namespace pia
21 {
22 namespace session
23 {
24 
25 static const uint32_t SessionJoinTimeoutDefault = 10000; //!< JoinMesh 処理のタイムアウト時間 [msec] のデフォルト値です。
26 static const uint32_t SessionDestroyTimeoutDefault = 5000; //!< DestroyMesh 処理のタイムアウト時間 [msec] のデフォルト値です。
27 static const uint32_t SessionLeaveTimeoutDefault = 5000; //!< LeaveMesh 処理のタイムアウト時間 [msec] のデフォルト値です。
28 
29 static const int32_t SessionKeepAliveIntervalDefault = 1000; //!< キープアライブの送信間隔 [msec] のデフォルト値です。
30 static const int32_t SessionMaxSilenceTimeDefault = 10000; //!< ステーションとの通信が断絶したと判断する無通信時間 [msec] のデフォルト値です。
31 static const int32_t SessionMaxSilenceTimeMax = 30000; //!< ステーションとの通信が断絶したと判断する無通信時間 [msec] の設定可能な最大値です。
32 static const int32_t SessionMaxSilenceTimeMin = 1000; //!< ステーションとの通信が断絶したと判断する無通信時間 [msec] の設定可能な最小値です。
33 
34 static const int32_t SessionUnicastUpdateMeshIntervalDefault = 5000; //!< セッション更新情報のブロードキャスト送信できない場合の送信間隔 [msec] のデフォルト値です。
35 static const int32_t SessionBroadcastUpdateMeshIntervalDefault = 2000; //!< セッション更新情報をブロードキャスト送信できる場合の送信間隔 [msec] のデフォルト値です。
36 
37 static const uint16_t SessionMaxRttDefault = 500; //!< 1つのリレー接続経路の合計 RTT の最大制限値 [msec] のデフォルト値です。
38 
39 static const int32_t SessionInvalidUplinkBitRateLowerLimit = -1; //!< ビットレート判定機能において、無効なビットレート値を表現する定数です。
40 
41 static const uint16_t SessionDefaultResultSize = 20; //!< 検索範囲のエントリー数のデフォルト値です。
42 
43 /*!
44 @brief Session クラス、Mesh クラスで構築するメッシュのネットワークトポロジーを設定するための列挙型です。
45 
46 @details 今後、Session クラス、Mesh クラスの機能追加に伴って追加する予定です。
47  */
49 {
50  NetworkTopology_FullMesh = 0, //!< フルメッシュ型(完全接続型)ネットワークトポロジー
51  NetworkTopology_RelayMesh //!< リレー接続有効メッシュ型ネットワークトポロジー
52 };
53 
54 
55 /*!
56 @brief ビットレート判定機能の設定を行うための列挙型です。
57  */
59 {
60  BitRateCheckMode_Disable = 0, //!< ビットレートの測定を行いません。
61  BitRateCheckMode_Enable //!< ビットレートの測定を行います。
62 };
63 
64 /*!
65 @cond PRIVATE
66 
67 @brief Session クラス、Mesh クラスで構築するメッシュのホストマイグレーションを設定するための列挙型です。
68 
69 @details 今後、Session クラス、Mesh クラスの機能追加に伴って追加する予定です。
70  */
71 enum HostMigrationMode
72 {
73  HostMigrationMode_None = 0, //!< ホストマイグレーションを使用しません。
74  HostMigrationMode_Solecandidate, //!< ホストマイグレーションを使用します。次のセッションホスト候補は単独候補です。
75  HostMigrationMode_Multicandidate //!< ホストマイグレーションを使用します。次のセッションホスト候補は複数候補です。
76 };
77 //! @endcond
78 
79 /*!
80  @brief 無効な SessionId を示す定数です。
81  */
82 static const uint32_t InvalidSessionId = 0;
83 
84 #if NN_PIA_NINTENDOSDK
85 static const int MaxFriendsAppScreenNameSize = 64;
86 #endif
87 }
88 }
89 }