fluencelabs/go-libp2p-kad-dht
1
0
Fork 0
mirror of https://github.com/fluencelabs/go-libp2p-kad-dht synced 2025-04-24 22:32:13 +00:00
Code Issues Projects Releases Wiki Activity

doc(options): document that disabling values/providers should only be done on forked dhts

Browse Source
This commit is contained in:
Steven Allen 2019-12-05 19:08:18 -05:00
parent 52747fc1f0
commit c2b72b250d
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
dht.go
View File

@ -74,6 +74,9 @@ type IpfsDHT struct {
maxRecordAge time.Duration maxRecordAge time.Duration
// Allows disabling dht subsystems. These should _only_ be set on
// "forked" DHTs (e.g., DHTs with custom protocols and/or private
// networks).
enableProviders, enableValues bool enableProviders, enableValues bool
} }

6
opts/options.go
View File

@ -185,6 +185,9 @@ func DisableAutoRefresh() Option {
// EnableProviders enables storing and retrieving provider records. // EnableProviders enables storing and retrieving provider records.
// //
// Defaults to true. // Defaults to true.
//
// WARNING: do not change this unless you're using a forked DHT (i.e., a private
// network and/or distinct DHT protocols with the `Protocols` option).
func EnableProviders(enable bool) Option { func EnableProviders(enable bool) Option {
return func(o *Options) error { return func(o *Options) error {
o.EnableProviders = enable o.EnableProviders = enable
@ -195,6 +198,9 @@ func EnableProviders(enable bool) Option {
// EnableValues enables storing and retrieving value records. // EnableValues enables storing and retrieving value records.
// //
// Defaults to true. // Defaults to true.
//
// WARNING: do not change this unless you're using a forked DHT (i.e., a private
// network and/or distinct DHT protocols with the `Protocols` option).
func EnableValues(enable bool) Option { func EnableValues(enable bool) Option {
return func(o *Options) error { return func(o *Options) error {
o.EnableValues = enable o.EnableValues = enable