go-ipfs-config: refactor: AutoRelay → RelayClient
https://github.com/ipfs/go-ipfs-config/pull/154#discussion_r749324695
Marcin Rataj committed
Nov 15, 2021 at 15:44 UTC
aefce5a6cd2881d50fc56192e770c0420255d06b
1 file changed
+5
-5
config/swarm.go
+5
-5
@@ -27,9 +27,9 @@ type SwarmConfig struct {
27
// `Swarm.AutoRelay.Enabled` if specified.
28
EnableAutoRelay bool `json:",omitempty"`
29
30
- // AutoRelay controls the "auto relay service" feature.
30
+ // RelayClient controls the client side of "auto relay" feature.
31
// When enabled, the node will use relays if it is not publicly reachable.
32
- AutoRelay AutoRelay
32
+ RelayClient RelayClient
33
34
// RelayService.* controls the "relay service".
35
// When enabled, node will provide a limited relay service to other peers.
@@ -42,8 +42,8 @@ type SwarmConfig struct {
42
ConnMgr ConnMgr
43
}
44
45
-type AutoRelay struct {
46
- // Enables the AutoRelay.
45
+type RelayClient struct {
46
+ // Enables the auto relay feature: will use relays if it is not publicly reachable.
47
Enabled Flag `json:",omitempty"`
48
49
// StaticRelays configures static relays to use when this node is not
@@ -55,7 +55,7 @@ type AutoRelay struct {
55
// RelayService configures the resources of the circuit v2 relay.
56
// For every field a reasonable default will be defined in go-ipfs.
57
type RelayService struct {
58
- // Enables the limited relay (circuit v2 relay).
58
+ // Enables the limited relay service for other peers (circuit v2 relay).
59
Enabled Flag `json:",omitempty"`
60
61
// ConnectionDurationLimit is the time limit before resetting a relayed connection.