Skip to content

Commit

Permalink
doc: update ConnectionType Doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jonatack committed Jan 10, 2021
1 parent 9de6a3c commit e711200
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/net.h
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ struct CSerializedNetMsg
* connection. Aside from INBOUND, all types are initiated by us.
*
* 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 {
/**
* Inbound connections are those initiated by a peer. This is the only
Expand All @@ -122,16 +123,16 @@ enum class ConnectionType {

/**
* 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
* MAX_OUTBOUND_FULL_RELAY_CONNECTIONS using addresses from our AddrMan.
*/
OUTBOUND_FULL_RELAY,


/**
* We open manual connections to addresses that users explicitly inputted
* via the addnode RPC, or the -connect command line argument. Even if a
* We open manual connections to addresses that users explicitly requested
* via the addnode RPC or the -addnode/-connect configuration options. Even if a
* manual connection is misbehaving, we do not automatically disconnect or
* add it to our discouragement filter.
*/
Expand All @@ -150,7 +151,7 @@ enum class ConnectionType {
* although in our codebase feeler connections encompass test-before-evict as well.
* We make these connections approximately every FEELER_INTERVAL:
* 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,

Expand Down

0 comments on commit e711200

Please sign in to comment.