Documentation
¶
Index ¶
- Variables
- type Option
- func Addrs(addrs []multiaddr.Multiaddr) Option
- func BootstrapPeers(addrs []multiaddr.Multiaddr) Option
- func BucketSize(bucketSize int) Option
- func Datastore(ds ds.Batching) Option
- func DisableProvGC() Option
- func DisableProviders() Option
- func DisableValues() Option
- func EnableRelay() Option
- func IDGenerator(g idgen.IdentityGenerator) Option
- func Limiter(l chan struct{}) Option
- func Peerstore(ps peerstore.Peerstore) Option
- func ProtocolPrefix(pfx protocol.ID) Option
- func RoutingTable(rt *kbucket.RoutingTable) Option
- type Options
Constants ¶
This section is empty.
Variables ¶
var Defaults = func(o *Options) error { o.Datastore = dssync.MutexWrap(ds.NewMapDatastore()) tcpAddr, _ := multiaddr.NewMultiaddr("/ip4/0.0.0.0/tcp/0") quicAddr, _ := multiaddr.NewMultiaddr("/ip4/0.0.0.0/udp/0/quic") o.Addrs = []multiaddr.Multiaddr{tcpAddr, quicAddr} o.ProtocolPrefix = dht.DefaultPrefix o.BucketSize = 20 o.BootstrapPeers = dht.DefaultBootstrapPeers o.IDGenerator = idgen.HydraIdentityGenerator return nil }
Defaults are the default Hydra Head options. This option will be automatically prepended to any options you pass to the Hydra Head constructor.
Functions ¶
This section is empty.
Types ¶
type Option ¶
Option is the Hydra Head option type.
func Addrs ¶ added in v0.3.2
func Addrs(addrs []multiaddr.Multiaddr) Option
Addrs configures the swarm addresses for this Hydra node. The default value is /ip4/0.0.0.0/tcp/0 and /ip4/0.0.0.0/udp/0/quic.
func BootstrapPeers ¶
func BootstrapPeers(addrs []multiaddr.Multiaddr) Option
BootstrapPeers configures the set of bootstrap peers that should be randomly selected from. The default value is `dht.DefaultBootstrapPeers`.
func BucketSize ¶
BucketSize configures the bucket size of the routing table. The default value is 20.
func Datastore ¶
Datastore configures the Hydra Head to use the specified datastore. Defaults to an in-memory (temporary) map.
func DisableProvGC ¶ added in v0.2.2
func DisableProvGC() Option
DisableProvGC disables garbage collections of provider records from the shared datastore. The default value is false.
func DisableProviders ¶ added in v0.2.3
func DisableProviders() Option
DisableProviders disables storing and retrieving provider records. The default value is false.
func DisableValues ¶ added in v0.2.3
func DisableValues() Option
DisableValues disables storing and retrieving value records (including public keys). The default value is false.
func EnableRelay ¶ added in v0.2.2
func EnableRelay() Option
EnableRelay configures whether this node acts as a relay node. The default value is false.
func IDGenerator ¶
func IDGenerator(g idgen.IdentityGenerator) Option
IDGenerator configures the identity generator. The default value is `idgen.HydraIdentityGenerator`.
func Limiter ¶
func Limiter(l chan struct{}) Option
Limiter configures ???. The default value is nil.
func Peerstore ¶ added in v0.6.0
Peerstore configures the Hydra Head to use the specified peerstore. Defaults to an in-memory (temporary) map.
func ProtocolPrefix ¶
ProtocolPrefix configures the application specific prefix attached to all DHT protocols by default. The default value is "/ipfs".
func RoutingTable ¶
func RoutingTable(rt *kbucket.RoutingTable) Option
RoutingTable configures the Hydra Head to use the specified routing table. Defaults to the routing table provided by IpfsDHT.
type Options ¶
type Options struct {
Datastore ds.Batching
Peerstore peerstore.Peerstore
RoutingTable *kbucket.RoutingTable
EnableRelay bool
Addrs []multiaddr.Multiaddr
ProtocolPrefix protocol.ID
BucketSize int
Limiter chan struct{}
BootstrapPeers []multiaddr.Multiaddr
IDGenerator idgen.IdentityGenerator
DisableProvGC bool
DisableProviders bool
DisableValues bool
}
Options are Hydra Head options
Source Files