/* * 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 . * * -- * * 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_ONESERVICE_HPP #define ZT_ONESERVICE_HPP #include namespace ZeroTier { class NetworkController; /** * Local service for ZeroTier One as system VPN/NFV provider */ class OneService { public: /** * Returned by node main if/when it terminates */ enum ReasonForTermination { /** * Instance is still running */ ONE_STILL_RUNNING = 0, /** * Normal shutdown */ ONE_NORMAL_TERMINATION = 1, /** * A serious unrecoverable error has occurred */ ONE_UNRECOVERABLE_ERROR = 2, /** * Your identity has collided with another */ ONE_IDENTITY_COLLISION = 3 }; /** * @return Platform default home path or empty string if this platform doesn't have one */ static std::string platformDefaultHomePath(); /** * Create a new instance of the service * * Once created, you must call the run() method to actually start * processing. * * @param hp Home path * @param port TCP and UDP port for packets and HTTP control * @param master Instance of network config master if this instance is to act as one (default: NULL) * @param overrideRootTopology String-serialized root topology (for testing, default: NULL) */ static OneService *newInstance( const char *hp, unsigned int port, NetworkController *master = (NetworkController *)0, const char *overrideRootTopology = (const char *)0); virtual ~OneService(); /** * Execute the service main I/O loop until terminated * * The terminate() method may be called from a signal handler or another * thread to terminate execution. Otherwise this will not return unless * another condition terminates execution such as a fatal error. * * @param */ virtual ReasonForTermination run() = 0; /** * @return Reason for terminating or ONE_STILL_RUNNING if running */ virtual ReasonForTermination reasonForTermination() const = 0; /** * @return Fatal error message or empty string if none */ virtual std::string fatalErrorMessage() const = 0; /** * @return System device name corresponding with a given ZeroTier network ID or empty string if not opened yet or network ID not found */ virtual std::string portDeviceName(uint64_t nwid) const = 0; /** * Terminate background service (can be called from other threads) */ virtual void terminate() = 0; /** * @return True if service is still running */ inline bool isRunning() const { return (this->reasonForTermination() == ONE_STILL_RUNNING); } protected: OneService() {} private: OneService(const OneService &one) {} inline OneService &operator=(const OneService &one) { return *this; } }; } // namespace ZeroTier #endif