CTR Pia  4.11.3
Game Communication Engine
local_LocalSessionStationInfo.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: local_LocalSessionStationInfo.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 <pia/local/local_definitions.h>
18 #include <pia/local/local_LocalNetworkSetting.h>
19 #include <pia/session/session_SessionStationInfo.h>
20 
21 namespace nn
22 {
23 namespace pia
24 {
25 namespace local
26 {
27 
28 /*!
29 @brief Represents information about a station that is participating in a session.
30 
31 @date 2014-05-27 Initial version.
32 */
34 {
35 public:
37  : m_pStationInfoList(NULL), m_ListLength(0)
38  {
39  }
40  virtual ~LocalSessionStationInfo()
41  {
42  }
43 
44 /*!
45 @brief Sets a buffer to store station information.
46 
47 @details Make the array length of lists provided as buffers equal to the maximum number of stations that can participate in the session.
48 
49 @param[in] pStationInfoList The buffer for storing station information.
50 @param[in] listLength The length of lists that can be provided as buffers.
51 */
52  void SetStationInfoListBuf(LocalStationInfo* pStationInfoList, u8 listLength)
53  {
54  m_pStationInfoList = pStationInfoList;
55  m_ListLength = listLength;
56  }
57 
58 /*!
59 @cond PRIVATE
60 */
61  LocalStationInfo* GetStationInfoListBuf()
62  {
63  return m_pStationInfoList;
64  }
65  //! @endcond
66 
67 /*!
68 @cond PRIVATE
69 */
70  u8 GetStationInfoListLength() const
71  {
72  return m_ListLength;
73  }
74  //! @endcond
75 
76 private:
77  LocalStationInfo* m_pStationInfoList;
78  u8 m_ListLength;
79 };
80 }
81 }
82 } // end of namespace nn::pia::local
Represents information about a station that is participating in a session.
Definition: local_LocalSessionStationInfo.h:33
Definition: assert.h:115
Represents information about a station that is participating in a session.
Definition: session_SessionStationInfo.h:31
void SetStationInfoListBuf(LocalStationInfo *pStationInfoList, u8 listLength)
Sets a buffer to store station information.
Definition: local_LocalSessionStationInfo.h:52
Class that holds information about stations connected to a local network.
Definition: local_LocalNetworkSetting.h:230