Spinning Topp Logo BlackTopp Studios
inc
networkmanager.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 
41 #ifndef _networkmanager_h
42 #define _networkmanager_h
43 
44 #include "entresolmanager.h"
45 #include "entresolmanagerfactory.h"
46 #include "singleton.h"
47 
48 namespace Mezzanine
49 {
50  namespace Network
51  {
52  class Socket;
53  ///////////////////////////////////////////////////////////////////////////////
54  /// @brief This is the central management class for all network I/O operations.
55  ///////////////////////////////////////
56  class MEZZ_LIB NetworkManager : public EntresolManager, public Singleton<NetworkManager>
57  {
58  public:
59  /// @brief A String containing the name of this manager implementation.
60  static const String ImplementationName;
61  /// @brief A ManagerType enum value used to describe the type of interface/functionality this manager provides.
63  protected:
64  //std::map<unsigned short int,Socket*> Sockets;
65  public:
66  /// @brief Class constructor.
68  /// @brief XML constructor.
69  /// @param XMLNode The node of the xml document to construct from.
70  NetworkManager(const XML::Node& XMLNode);
71  /// @brief Class destructor.
72  virtual ~NetworkManager();
73 
74  ///////////////////////////////////////////////////////////////////////////////
75  // Sockets Management
76 
77  ///////////////////////////////////////////////////////////////////////////////
78  // Network Utilities
79 
80  ///////////////////////////////////////////////////////////////////////////////
81  // Utility
82 
83  /// @copydoc ManagerBase::Initialize()
84  virtual void Initialize();
85  /// @copydoc ManagerBase::Deinitialize()
86  virtual void Deinitialize();
87 
88  ///////////////////////////////////////////////////////////////////////////////
89  // Type Identifier Methods
90 
91  /// @copydoc ManagerBase::GetInterfaceType()
92  virtual ManagerType GetInterfaceType() const;
93  /// @copydoc ManagerBase::GetImplementationTypeName()
94  virtual String GetImplementationTypeName() const;
95  };//NetworkManager
96 
97  ///////////////////////////////////////////////////////////////////////////////
98  /// @brief A factory responsible for the creation and destruction of the default networkmanager.
99  ///////////////////////////////////////
101  {
102  public:
103  /// @brief Class constructor.
105  /// @brief Class destructor.
106  virtual ~DefaultNetworkManagerFactory();
107 
108  /// @copydoc ManagerFactory::GetManagerImplName()
109  String GetManagerImplName() const;
110  /// @copydoc ManagerFactory::GetManagerType() const
111  ManagerBase::ManagerType GetManagerType() const;
112 
113  /// @copydoc EntresolManagerFactory::CreateManager(const NameValuePairList&)
114  EntresolManager* CreateManager(const NameValuePairList& Params);
115  /// @copydoc EntresolManagerFactory::CreateManager(const XML::Node&)
116  EntresolManager* CreateManager(const XML::Node& XMLNode);
117  /// @copydoc EntresolManagerFactory::DestroyManager(EntresolManager*)
118  void DestroyManager(EntresolManager* ToBeDestroyed);
119  };//DefaultNetworkManagerFactory
120  }//Network
121 }//Mezzanine
122 
123 #endif
A factory responsible for the creation and destruction of the default networkmanager.
ManagerType
A listing of Manager Types.
Definition: managerbase.h:65
static const ManagerBase::ManagerType InterfaceType
A ManagerType enum value used to describe the type of interface/functionality this manager provides...
This is a base class for factories that construct managers used by the Entresol class.
This is a convenience base class intended to be used with classes that need to be singletons...
Definition: singleton.h:62
This is the base class for all managers that do no describe properties of a single world...
A light-weight handle for manipulating nodes in DOM tree.
Definition: node.h:89
std::list< NameValuePair > NameValuePairList
This is a datatype mostly used for describing settings or parameters that can't be declared in advanc...
Definition: datatypes.h:206
static const String ImplementationName
A String containing the name of this manager implementation.
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
This is the central management class for all network I/O operations.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159