CTR Pia  4.11.3
Game Communication Engine
local_UdsCreateSessionSetting.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: local_UdsCreateSessionSetting.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_LocalCreateSessionSetting.h>
18 #include <pia/local/local_UdsNetworkSetting.h>
19 
20 namespace nn
21 {
22 namespace pia
23 {
24 namespace local
25 {
26 /*!
27 @brief Class that manages the <tt>CreateSession</tt> settings for networks using the UDS library (local communication).
28 
29 @date 2014-03-03 Initial version.
30 */
32 {
33 public:
34 /*!
35 @brief Instantiates an object.
36 */
38 
39 /*!
40 @brief Destroys the object.
41 */
42  virtual ~UdsCreateSessionSetting();
43 
44 /*!
45 @cond PRIVATE
46 */
47  virtual const LocalCreateNetworkSetting* GetLocalCreateNetworkSetting() const
48  {
49  return &m_UdsCreateNetworkSetting;
50  }
51  //! @endcond
52 
53 /*!
54 @brief Specifies the settings used when generating the network.
55 
56 @param[in] createNetworkSetting Settings used when the network is generated.
57 */
58  virtual void SetLocalCreateNetworkSetting(const LocalCreateNetworkSetting& createNetworkSetting);
59 
60  // Prints information that is useful for debugging.
61  virtual void Trace(u64 flag) const;
62 
63 protected:
64  UdsCreateNetworkSetting m_UdsCreateNetworkSetting;
65 
66 private:
67  // The copy constructor is sealed.
69 
70  // The assignment operator is sealed.
72 };
73 }
74 }
75 } // end of namespace nn::pia::local
Class for configuring the creation of networks that use the UDS library.
Definition: local_UdsNetworkSetting.h:76
Base class that manages the settings for the CreateSession function with a LocalNetwork object...
Definition: local_LocalCreateSessionSetting.h:42
Definition: assert.h:115
virtual void SetLocalCreateNetworkSetting(const LocalCreateNetworkSetting &createNetworkSetting)
Specifies the settings used when generating the network.
Class that manages the CreateSession settings for networks using the UDS library (local communication...
Definition: local_UdsCreateSessionSetting.h:31
Class for configuring the creation of a local network.
Definition: local_LocalNetworkSetting.h:102
UdsCreateSessionSetting()
Instantiates an object.
virtual ~UdsCreateSessionSetting()
Destroys the object.