foster/bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-06 14:19:59 -05:00
Code Issues Activity

doc: update ConnectionType Doxygen documentation

Browse source
This commit is contained in:
Jon Atack 2021-01-10 18:17:12 +01:00
parent f3153dc08f
commit 79a2576af1
No known key found for this signature in database
GPG key ID: 4F5721B3D0E3921D
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/net.h
View file

@ -111,7 +111,8 @@ struct CSerializedNetMsg
* connection. Aside from INBOUND, all types are initiated by us. * connection. Aside from INBOUND, all types are initiated by us.
* *
* If adding or removing types, please update CONNECTION_TYPE_DOC in * If adding or removing types, please update CONNECTION_TYPE_DOC in
* src/rpc/net.cpp. */ * src/rpc/net.cpp and src/qt/rpcconsole.cpp, as well as the descriptions in
* src/qt/guiutil.cpp and src/bitcoin-cli.cpp::NetinfoRequestHandler. */
enum class ConnectionType { enum class ConnectionType {
/** /**
* Inbound connections are those initiated by a peer. This is the only * Inbound connections are those initiated by a peer. This is the only
@ -122,7 +123,7 @@ enum class ConnectionType {
/** /**
* These are the default connections that we use to connect with the * These are the default connections that we use to connect with the
* network. There is no restriction on what is relayed- by default we relay * network. There is no restriction on what is relayed; by default we relay
* blocks, addresses & transactions. We automatically attempt to open * blocks, addresses & transactions. We automatically attempt to open
* MAX_OUTBOUND_FULL_RELAY_CONNECTIONS using addresses from our AddrMan. * MAX_OUTBOUND_FULL_RELAY_CONNECTIONS using addresses from our AddrMan.
*/ */
@ -130,8 +131,8 @@ enum class ConnectionType {
/** /**
* We open manual connections to addresses that users explicitly inputted * We open manual connections to addresses that users explicitly requested
* via the addnode RPC, or the -connect command line argument. Even if a * via the addnode RPC or the -addnode/-connect configuration options. Even if a
* manual connection is misbehaving, we do not automatically disconnect or * manual connection is misbehaving, we do not automatically disconnect or
* add it to our discouragement filter. * add it to our discouragement filter.
*/ */
@ -150,7 +151,7 @@ enum class ConnectionType {
* although in our codebase feeler connections encompass test-before-evict as well. * although in our codebase feeler connections encompass test-before-evict as well.
* We make these connections approximately every FEELER_INTERVAL: * We make these connections approximately every FEELER_INTERVAL:
* first we resolve previously found collisions if they exist (test-before-evict), * first we resolve previously found collisions if they exist (test-before-evict),
* otherwise connect to a node from the new table. * otherwise we connect to a node from the new table.
*/ */
FEELER, FEELER,