2010-07-14 17:54:31 +02:00
|
|
|
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
2015-12-13 14:51:43 +01:00
|
|
|
// Copyright (c) 2009-2015 The Bitcoin Core developers
|
2014-12-01 02:39:44 +01:00
|
|
|
// Distributed under the MIT software license, see the accompanying
|
2012-05-18 16:02:28 +02:00
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
2013-04-13 07:13:08 +02:00
|
|
|
|
2011-05-15 09:11:04 +02:00
|
|
|
#ifndef BITCOIN_INIT_H
|
|
|
|
#define BITCOIN_INIT_H
|
2010-07-14 17:54:31 +02:00
|
|
|
|
2013-10-19 18:42:14 +02:00
|
|
|
#include <string>
|
|
|
|
|
2015-04-03 17:50:06 +02:00
|
|
|
class CScheduler;
|
2013-10-19 18:42:14 +02:00
|
|
|
class CWallet;
|
2012-04-15 22:10:54 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
namespace boost
|
|
|
|
{
|
|
|
|
class thread_group;
|
2014-06-24 14:17:43 +02:00
|
|
|
} // namespace boost
|
2013-04-13 07:13:08 +02:00
|
|
|
|
2012-06-11 07:40:14 +02:00
|
|
|
void StartShutdown();
|
2018-03-19 14:09:47 +01:00
|
|
|
void StartRestart();
|
2013-03-23 23:14:12 +01:00
|
|
|
bool ShutdownRequested();
|
evhttpd implementation
- *Replace usage of boost::asio with [libevent2](http://libevent.org/)*.
boost::asio is not part of C++11, so unlike other boost there is no
forwards-compatibility reason to stick with it. Together with #4738 (convert
json_spirit to UniValue), this rids Bitcoin Core of the worst offenders with
regard to compile-time slowness.
- *Replace spit-and-duct-tape http server with evhttp*. Front-end http handling
is handled by libevent, a work queue (with configurable depth and parallelism)
is used to handle application requests.
- *Wrap HTTP request in C++ class*; this makes the application code mostly
HTTP-server-neutral
- *Refactor RPC to move all http-specific code to a separate file*.
Theoreticaly this can allow building without HTTP server but with another RPC
backend, e.g. Qt's debug console (currently not implemented) or future RPC
mechanisms people may want to use.
- *HTTP dispatch mechanism*; services (e.g., RPC, REST) register which URL
paths they want to handle.
By using a proven, high-performance asynchronous networking library (also used
by Tor) and HTTP server, problems such as #5674, #5655, #344 should be avoided.
What works? bitcoind, bitcoin-cli, bitcoin-qt. Unit tests and RPC/REST tests
pass. The aim for now is everything but SSL support.
Configuration options:
- `-rpcthreads`: repurposed as "number of work handler threads". Still
defaults to 4.
- `-rpcworkqueue`: maximum depth of work queue. When this is reached, new
requests will return a 500 Internal Error.
- `-rpctimeout`: inactivity time, in seconds, after which to disconnect a
client.
- `-debug=http`: low-level http activity logging
2015-01-23 07:53:17 +01:00
|
|
|
/** Interrupt threads */
|
2018-01-30 12:34:11 +01:00
|
|
|
void Interrupt();
|
2013-03-09 18:02:57 +01:00
|
|
|
void Shutdown();
|
2015-11-26 14:03:27 +01:00
|
|
|
//!Initialize the logging infrastructure
|
|
|
|
void InitLogging();
|
2015-10-08 09:58:31 +02:00
|
|
|
//!Parameter interaction: change current parameters depending on various rules
|
|
|
|
void InitParameterInteraction();
|
2016-12-01 01:07:21 +01:00
|
|
|
|
|
|
|
/** Initialize bitcoin core: Basic context setup.
|
2017-07-17 17:12:00 +02:00
|
|
|
* @note This can be done before daemonization. Do not call Shutdown() if this function fails.
|
2016-12-01 01:07:21 +01:00
|
|
|
* @pre Parameters should be parsed and config file should be read.
|
|
|
|
*/
|
|
|
|
bool AppInitBasicSetup();
|
|
|
|
/**
|
|
|
|
* Initialization: parameter interaction.
|
2017-07-17 17:12:00 +02:00
|
|
|
* @note This can be done before daemonization. Do not call Shutdown() if this function fails.
|
2016-12-01 01:07:21 +01:00
|
|
|
* @pre Parameters should be parsed and config file should be read, AppInitBasicSetup should have been called.
|
|
|
|
*/
|
|
|
|
bool AppInitParameterInteraction();
|
|
|
|
/**
|
|
|
|
* Initialization sanity checks: ecc init, sanity checks, dir lock.
|
2017-07-17 17:12:00 +02:00
|
|
|
* @note This can be done before daemonization. Do not call Shutdown() if this function fails.
|
2016-12-01 01:07:21 +01:00
|
|
|
* @pre Parameters should be parsed and config file should be read, AppInitParameterInteraction should have been called.
|
|
|
|
*/
|
|
|
|
bool AppInitSanityChecks();
|
|
|
|
/**
|
2017-07-17 17:12:00 +02:00
|
|
|
* Lock bitcoin core data directory.
|
|
|
|
* @note This should only be done after daemonization. Do not call Shutdown() if this function fails.
|
2016-12-01 01:07:21 +01:00
|
|
|
* @pre Parameters should be parsed and config file should be read, AppInitSanityChecks should have been called.
|
|
|
|
*/
|
2017-07-17 17:12:00 +02:00
|
|
|
bool AppInitLockDataDirectory();
|
|
|
|
/**
|
|
|
|
* Bitcoin core main initialization.
|
|
|
|
* @note This should only be done after daemonization. Call Shutdown() if this function fails.
|
|
|
|
* @pre Parameters should be parsed and config file should be read, AppInitLockDataDirectory should have been called.
|
|
|
|
*/
|
2018-01-30 12:34:11 +01:00
|
|
|
bool AppInitMain();
|
2015-05-28 23:09:14 +02:00
|
|
|
void PrepareShutdown();
|
2013-10-11 23:09:59 +02:00
|
|
|
|
2014-12-01 02:39:44 +01:00
|
|
|
/** The help message mode determines what help message to show */
|
2014-09-19 19:21:46 +02:00
|
|
|
enum HelpMessageMode {
|
2013-10-11 23:09:59 +02:00
|
|
|
HMM_BITCOIND,
|
2013-11-27 15:41:12 +01:00
|
|
|
HMM_BITCOIN_QT
|
2013-10-11 23:09:59 +02:00
|
|
|
};
|
|
|
|
|
2014-06-10 16:02:46 +02:00
|
|
|
/** Help for options shared between UI and daemon (for -help) */
|
2013-10-11 23:09:59 +02:00
|
|
|
std::string HelpMessage(HelpMessageMode mode);
|
2014-06-10 16:02:46 +02:00
|
|
|
/** Returns licensing information (for -version) */
|
|
|
|
std::string LicenseInfo();
|
2011-05-15 09:11:04 +02:00
|
|
|
|
2014-08-28 22:21:03 +02:00
|
|
|
#endif // BITCOIN_INIT_H
|