CTR Pia  4.11.3
Game Communication Engine
platformCtr.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: platformCtr.h
4 
5  Copyright Nintendo. All rights reserved.
6 
7  These coded instructions, statements, and computer programs contain
8  proprietary information of Nintendo of America Inc. and/or Nintendo
9  Company Ltd., and are protected by Federal copyright law. They may
10  not be disclosed to third parties or copied or duplicated in any form,
11  in whole or in part, without the prior written consent of Nintendo.
12  *---------------------------------------------------------------------------*/
13 
14 
15 #pragma once
16 
17 #include <nn/types.h>
18 #include <nn/Result.h>
19 #include <pia/platform/basicMacrosCtr.h>
20 #include <nn/uds.h>
21 
22 #define NN_PIA_ENDIAN_BIG 0
23 
24 namespace nn
25 {
26 namespace pia
27 {
28 
29 /*!
30 @cond CTR_DOC
31 @brief Enumerates <tt>StationIndex</tt> values.
32 
33 @details The Pia modules use <tt>StationIndex</tt> as a station identifier within the session regardless of the network type.
34 IDs were created with the intention of having the application handle information from each station as an array.
35 
36 The maximum value changes whenever the maximum number of simultaneous connections that the Pia library can support changes.
37 
38 @date 2013-02-01 Changed <tt>STATION_INDEX_MAX</tt> and <tt>MAX_STATION_NUM</tt> to 12 to match the maximum number of simultaneous connection supported by the Pia library.
39 @date 2012-04-05 Moved from the <tt>nn::pia::common</tt> namespace to the <tt>nn::pia</tt> namespace.
40 
41 
42 
43 */
45 {
46  STATION_INDEX_1 = 0, //!< ID indicating Player 1.
47  STATION_INDEX_2, //!< ID indicating Player 2.
48  STATION_INDEX_3, //!< ID indicating Player 3.
49  STATION_INDEX_4, //!< ID indicating Player 4.
50  STATION_INDEX_5, //!< ID indicating Player 5.
51  STATION_INDEX_6, //!< ID indicating Player 6.
52  STATION_INDEX_7, //!< ID indicating Player 7.
53  STATION_INDEX_8, //!< ID indicating Player 8.
54  STATION_INDEX_9, //!< ID indicating Player 9.
55  STATION_INDEX_10, //!< ID indicating Player 10.
56  STATION_INDEX_11, //!< ID indicating Player 11.
57  STATION_INDEX_12, //!< ID indicating Player 12.
58  STATION_INDEX_MAX = STATION_INDEX_12, //!< Maximum value of <tt>StationIndex</tt>.
59  STATION_INDEX_INVALID = 0xfd, //!< ID indicating a station that is not present in the session.
60  STATION_INDEX_HOST = 0xfe, //!< ID indicating the station that holds the role of host.
61  STATION_INDEX_ALL = 0xff //!< ID indicating all stations in the session.
62 };
63 
64 const size_t MAX_STATION_NUM = 12; //!< The maximum value for the number of stations that can participate in a Pia session.
65 }
66 } // end of namespace nn::pia
67 
68 //! @endcond
ID indicating Player 11.
Definition: platformCtr.h:56
ID indicating Player 12.
Definition: platformCtr.h:57
ID indicating Player 5.
Definition: platformCtr.h:50
ID indicating Player 2.
Definition: platformCtr.h:47
StationIndex
Enumerates StationIndex values.
Definition: platformCtr.h:44
ID indicating Player 6.
Definition: platformCtr.h:51
Definition: assert.h:115
ID indicating Player 1.
Definition: platformCtr.h:46
ID indicating all stations in the session.
Definition: platformCtr.h:61
ID indicating a station that is not present in the session.
Definition: platformCtr.h:59
ID indicating Player 9.
Definition: platformCtr.h:54
const size_t MAX_STATION_NUM
The maximum value for the number of stations that can participate in a Pia session.
Definition: platformCtr.h:64
ID indicating Player 4.
Definition: platformCtr.h:49
ID indicating the station that holds the role of host.
Definition: platformCtr.h:60
ID indicating Player 10.
Definition: platformCtr.h:55
ID indicating Player 8.
Definition: platformCtr.h:53
ID indicating Player 3.
Definition: platformCtr.h:48
ID indicating Player 7.
Definition: platformCtr.h:52
Maximum value of StationIndex.
Definition: platformCtr.h:58