ZeroTierOne/node/RuntimeEnvironment.hpp

140 lines
3.9 KiB
C++

/*
* ZeroTier One - Network Virtualization Everywhere
* Copyright (C) 2011-2015 ZeroTier, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* --
*
* ZeroTier may be used and distributed under the terms of the GPLv3, which
* are available at: http://www.gnu.org/licenses/gpl-3.0.html
*
* If you would like to embed ZeroTier into a commercial application or
* redistribute it in a modified binary form, please contact ZeroTier Networks
* LLC. Start here: http://www.zerotier.com/
*/
#ifndef ZT_RUNTIMEENVIRONMENT_HPP
#define ZT_RUNTIMEENVIRONMENT_HPP
#include <string>
#include "Constants.hpp"
#include "Identity.hpp"
namespace ZeroTier {
class NodeConfig;
class Logger;
class Switch;
class Topology;
class CMWC4096;
class Node;
class SoftwareUpdater;
class SocketManager;
class Multicaster;
class AntiRecursion;
class EthernetTapFactory;
class RoutingTable;
class HttpClient;
class NetworkConfigMaster;
/**
* Holds global state for an instance of ZeroTier::Node
*
* I do not believe in mutable static variables, period, or in global static
* instances of objects that don't basically represent constants. It makes
* unit testing, embedding, threading, and other things hard and is poor
* practice.
*
* So we put everything that we would want to be global, like Logger, here
* and we give everybody this as _r. The Node creates and initializes this
* on startup and deletes things on shutdown.
*/
class RuntimeEnvironment
{
public:
RuntimeEnvironment() :
homePath(),
identity(),
initialized(false),
tcpTunnelingEnabled(false),
timeOfLastResynchronize(0),
timeOfLastPacketReceived(0),
tapFactory((EthernetTapFactory *)0),
routingTable((RoutingTable *)0),
sm((SocketManager *)0),
log((Logger *)0),
prng((CMWC4096 *)0),
http((HttpClient *)0),
netconfMaster((NetworkConfigMaster *)0),
sw((Switch *)0),
mc((Multicaster *)0),
antiRec((AntiRecursion *)0),
topology((Topology *)0),
nc((NodeConfig *)0),
node((Node *)0),
updater((SoftwareUpdater *)0)
{
}
// Full path to home folder
std::string homePath;
// This node's identity
Identity identity;
// Are we initialized?
volatile bool initialized;
// Are we in outgoing TCP failover mode?
volatile bool tcpTunnelingEnabled;
// Time network environment (e.g. fingerprint) last changed -- used to determine online-ness
volatile uint64_t timeOfLastResynchronize;
// Time last packet was received -- from anywhere. This is updated in Peer::receive()
// via an ugly const_cast<>.
volatile uint64_t timeOfLastPacketReceived;
// These are passed in from outside and are not created or deleted by the ZeroTier node core
EthernetTapFactory *tapFactory;
RoutingTable *routingTable;
SocketManager *sm;
/*
* Order matters a bit here. These are constructed in this order
* and then deleted in the opposite order on Node exit. The order ensures
* that things that are needed are there before they're needed.
*
* These are constant and never null after startup unless indicated.
*/
Logger *log; // null if logging is disabled
CMWC4096 *prng;
HttpClient *http;
NetworkConfigMaster *netconfMaster;
Switch *sw;
Multicaster *mc;
AntiRecursion *antiRec;
Topology *topology;
NodeConfig *nc;
Node *node;
SoftwareUpdater *updater; // null if software updates are not enabled
};
} // namespace ZeroTier
#endif