SmartFoxServer 2X C++ API
RoomExtension.h
1 // ===================================================================
2 //
3 // Description
4 // Contains the definition of RoomExtension
5 //
6 // Revision history
7 // Date Description
8 // 30-Nov-2012 First version
9 //
10 // ===================================================================
11 #ifndef __RoomExtension__
12 #define __RoomExtension__
13 
14 #include "../Util/Common.h"
15 
16 #include <boost/shared_ptr.hpp> // Boost Asio shared pointer
17 
18 #if defined(_MSC_VER)
19 #pragma warning(disable:4786) // STL library: disable warning 4786; this warning is generated due to a Microsoft bug
20 #endif
21 #include <string> // STL library: string object
22 using namespace std; // STL library: declare the STL namespace
23 
24 namespace Sfs2X {
25 namespace Requests {
26 
35  class DLLImportExport RoomExtension
36  {
37  public:
38 
39  // -------------------------------------------------------------------
40  // Public methods
41  // -------------------------------------------------------------------
53  RoomExtension(string id, string className);
54 
58  boost::shared_ptr<string> Id();
59 
63  boost::shared_ptr<string> ClassName();
64 
68  boost::shared_ptr<string> PropertiesFile();
69 
73  void PropertiesFile(string value);
74 
75  // -------------------------------------------------------------------
76  // Public members
77  // -------------------------------------------------------------------
78 
79  protected:
80 
81  // -------------------------------------------------------------------
82  // Protected methods
83  // -------------------------------------------------------------------
84 
85  // -------------------------------------------------------------------
86  // Protected members
87  // -------------------------------------------------------------------
88 
89  private:
90 
91  // -------------------------------------------------------------------
92  // Private methods
93  // -------------------------------------------------------------------
94 
95  // -------------------------------------------------------------------
96  // Private members
97  // -------------------------------------------------------------------
98  boost::shared_ptr<string> id; // <-- mandatory
99  boost::shared_ptr<string> className; // <-- mandatory
100  boost::shared_ptr<string> propertiesFile; // <-- optional
101  };
102 
103 } // namespace Requests
104 } // namespace Sfs2X
105 
106 #endif
STL namespace.
This object is part of the RoomSettings parameters used for creating a new Room.
Definition: RoomExtension.h:35
Definition: SmartFox.cpp:24