History

Aarush Bhat 65e986844e Update connmanager_test.go		2021-11-10 07:59:03 -05:00
..
README.md	docs: update shields	2021-03-05 07:45:19 -05:00
connmanager.go	connmgr: check for canceled connection before connect	2019-04-09 19:54:18 -07:00
connmanager_test.go	Update connmanager_test.go	2021-11-10 07:59:03 -05:00
doc.go	connmgr: Refactor connection management into pkg	2016-10-22 01:11:57 -05:00
dynamicbanscore.go	BUG:dynamicbanscore deadlock	2020-03-09 13:41:13 -04:00
dynamicbanscore_test.go	BUG:dynamicbanscore deadlock	2020-03-09 13:41:13 -04:00
log.go	connmgr: Refactor connection management into pkg	2016-10-22 01:11:57 -05:00
seed.go	wire: Treat NetAddress more like immutable	2016-12-06 20:48:02 +01:00
tor.go	Fix comparator that could cause a panic	2017-06-07 17:59:33 -05:00

README.md

connmgr

Package connmgr implements a generic Bitcoin network connection manager.

Overview

Connection Manager handles all the general connection concerns such as maintaining a set number of outbound connections, sourcing peers, banning, limiting max connections, tor lookup, etc.

The package provides a generic connection manager which is able to accept connection requests from a source or a set of given addresses, dial them and notify the caller on connections. The main intended use is to initialize a pool of active connections and maintain them to remain connected to the P2P network.

In addition the connection manager provides the following utilities:

Notifications on connections or disconnections
Handle failures and retry new addresses from the source
Connect only to specified addresses
Permanent connections with increasing backoff retry timers
Disconnect or Remove an established connection

Installation and Updating

$ go get -u github.com/btcsuite/btcd/connmgr

License

Package connmgr is licensed under the copyfree ISC License.