mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 18:37:45 +08:00
config: document the connection manager
License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
This commit is contained in:
parent
7956adad22
commit
716f69b8f8
@ -311,6 +311,7 @@ Tells reprovider what should be announced. Valid strategies are:
|
||||
- "roots" - only announce directly pinned keys and root keys of recursive pins
|
||||
|
||||
## `Swarm`
|
||||
|
||||
Options for configuring the swarm.
|
||||
|
||||
- `AddrFilters`
|
||||
@ -334,15 +335,41 @@ Enables HOP relay for the node. If this is enabled, the node will act as
|
||||
an intermediate (Hop Relay) node in relay circuits for connected peers.
|
||||
|
||||
### `ConnMgr`
|
||||
Connection manager configuration.
|
||||
|
||||
The connection manager determines which and how many connections to keep and can be configured to keep.
|
||||
|
||||
- `Type`
|
||||
Sets the type of connection manager to use, options are: `"none"` and `"basic"`.
|
||||
Sets the type of connection manager to use, options are: `"none"` (no connection management) and `"basic"`.
|
||||
|
||||
#### Basic Connection Manager
|
||||
|
||||
- `LowWater`
|
||||
LowWater is the minimum number of connections to maintain.
|
||||
|
||||
- `HighWater`
|
||||
HighWater is the number of connections that, when exceeded, will trigger a connection GC operation.
|
||||
|
||||
- `GracePeriod`
|
||||
GracePeriod is a time duration that new connections are immune from being closed by the connection manager.
|
||||
|
||||
The "basic" connection manager tries to keep between `LowWater` and `HighWater` connections. It works by:
|
||||
|
||||
1. Keeping all connections until `HighWater` connections is reached.
|
||||
2. Once `HighWater` is reached, it closes connections until `LowWater` is reached.
|
||||
3. To prevent thrashing, it never closes connections established within the `GracePeriod`.
|
||||
|
||||
**Example:**
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"Swarm": {
|
||||
"ConnMgr": {
|
||||
"Type": "basic",
|
||||
"LowWater": 100,
|
||||
"HighWater": 200,
|
||||
"GracePeriod": "30s"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user