config: Port some docstrings from go-ipfs

This commit is contained in:
Łukasz Magiera 2021-08-27 19:16:50 +02:00
parent 17b7dcef6f
commit 3708a7ac30
2 changed files with 16 additions and 5 deletions

View File

@ -361,19 +361,23 @@ it makes the local lotus node accessible from the public internet`,
Name: "ConnMgrLow", Name: "ConnMgrLow",
Type: "uint", Type: "uint",
Comment: ``, Comment: `ConnMgrLow is the number of connections that the basic connection manager
will trim down to.`,
}, },
{ {
Name: "ConnMgrHigh", Name: "ConnMgrHigh",
Type: "uint", Type: "uint",
Comment: ``, Comment: `ConnMgrHigh is the number of connections that, when exceeded, will trigger
a connection GC operation. Note: protected/recently formed connections don't
count towards this limit.`,
}, },
{ {
Name: "ConnMgrGrace", Name: "ConnMgrGrace",
Type: "Duration", Type: "Duration",
Comment: ``, Comment: `ConnMgrGrace is a time duration that new connections are immune from being
closed by the connection manager.`,
}, },
}, },
"MinerAddressConfig": []DocField{ "MinerAddressConfig": []DocField{

View File

@ -298,8 +298,15 @@ type Libp2p struct {
// it makes the local lotus node accessible from the public internet // it makes the local lotus node accessible from the public internet
DisableNatPortMap bool DisableNatPortMap bool
// ConnMgrLow is the number of connections that the basic connection manager
// will trim down to.
ConnMgrLow uint ConnMgrLow uint
// ConnMgrHigh is the number of connections that, when exceeded, will trigger
// a connection GC operation. Note: protected/recently formed connections don't
// count towards this limit.
ConnMgrHigh uint ConnMgrHigh uint
// ConnMgrGrace is a time duration that new connections are immune from being
// closed by the connection manager.
ConnMgrGrace Duration ConnMgrGrace Duration
} }