Spinning Topp Logo BlackTopp Studios
inc
networkmanager.cpp
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_cpp
42 #define _networkmanager_cpp
43 
44 #include "networkmanager.h"
45 
46 namespace Mezzanine
47 {
48  template<> Network::NetworkManager* Singleton<Network::NetworkManager>::SingletonPtr = NULL;
49 
50  namespace Network
51  {
52  const String NetworkManager::ImplementationName = "DefaultNetworkManager";
53  const ManagerBase::ManagerType NetworkManager::InterfaceType = ManagerBase::MT_NetworkManager;
54 
56  { }
57 
59  {
60  /// @todo This class currently doesn't initialize anything from XML, if that changes this constructor needs to be expanded.
61  }
62 
64  {
65  this->Deinitialize();
66  }
67 
68  ///////////////////////////////////////////////////////////////////////////////
69  // Sockets Management
70 
71  ///////////////////////////////////////////////////////////////////////////////
72  // Network Utilities
73 
74  ///////////////////////////////////////////////////////////////////////////////
75  // Utility
76 
78  { this->Initialized = true; }
79 
81  { this->Initialized = false; }
82 
83  ///////////////////////////////////////////////////////////////////////////////
84  // Type Identifier Methods
85 
88 
91 
92  ///////////////////////////////////////////////////////////////////////////////
93  // DefaultNetworkManagerFactory Methods
94 
96  { }
97 
99  { }
100 
103 
106 
108  {
110  /// @todo Add something to log a warning that the manager exists and was requested to be constructed when we have a logging manager set up.
112  }else return new NetworkManager();
113  }
114 
116  {
118  /// @todo Add something to log a warning that the manager exists and was requested to be constructed when we have a logging manager set up.
120  }else return new NetworkManager(XMLNode);
121  }
122 
124  { delete ToBeDestroyed; }
125  }//Network
126 }//Mezzanine
127 
128 #endif
virtual ~NetworkManager()
Class destructor.
virtual ~DefaultNetworkManagerFactory()
Class destructor.
virtual void Deinitialize()
Removes this manager from any necessary configuration so it can be safely disposed of...
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...
EntresolManager * CreateManager(const NameValuePairList &Params)
Creates a manager of the type represented by this factory.
static Boole SingletonValid()
Checks to see if the singleton pointer is valid.
Definition: singleton.h:110
static NetworkManager * GetSingletonPtr()
Fetches a pointer to the singleton.
Definition: singleton.h:97
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
virtual ManagerType GetInterfaceType() const
This returns the type of this manager.
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
ManagerBase::ManagerType GetManagerType() const
Gets the type of manager that is created by this factory.
String GetManagerImplName() const
Gets the name of the manager that is created by this factory.
static const String ImplementationName
A String containing the name of this manager implementation.
virtual void Initialize()
Configures this manager for use prior to entering the main loop.
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
virtual String GetImplementationTypeName() const
This Allows any manager name to be sent to a stream. Primarily used for logging.
void DestroyManager(EntresolManager *ToBeDestroyed)
Destroys a Manager created by this factory.
Boole Initialized
Simple Boole indicating whether or not this manager has been initialized.
Definition: managerbase.h:111