# Packages
Package cid implements the Content-IDentifiers specification (https://github.com/ipld/cid) in Go.
No description provided by the author
Package core 通过类型别名提供对基础的、核心的 go-dep2p 原语的便捷访问。.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
AddrsFactory 配置dep2p使用给定的地址工厂 参数: - factory: 地址工厂实现
返回: - Option: 配置函数.
AutoNATServiceRateLimit 更改帮助其他对等点确定其可达性状态的默认速率限制 设置后,主机将限制在每60秒期间响应的请求数量为设定的数字 值为'0'禁用限制 参数: - global: 全局限制 - perPeer: 每个对等点限制 - interval: 限制间隔
返回: - Option: 配置函数.
BandwidthReporter 配置dep2p使用给定的带宽报告器 参数: - rep: 带宽报告器实现
返回: - Option: 配置函数.
ChainOptions 将多个选项链接成单个选项 参数: - opts: ...Option 要链接的选项列表
返回: - Option: 链接后的单个选项函数.
ConnectionGater 配置dep2p使用给定的ConnectionGater根据连接的生命周期阶段主动拒绝入站/出站连接 参数: - cg: 连接门控器实现
返回: - Option: 配置函数.
ConnectionManager 配置dep2p使用给定的连接管理器 当前"标准"连接管理器位于github.com/dep2p/go-dep2p-connmgr 参数: - connman: 连接管理器实现
返回: - Option: 配置函数.
DialRanker 配置dep2p使用d作为拨号排序器。要启用智能拨号,使用`swarm.DefaultDialRanker`。使用`swarm.NoDelayDialRanker`禁用智能拨号
已弃用:使用SwarmOpts(swarm.WithDialRanker(d))代替 参数: - d: 拨号排序器实现
返回: - Option: 配置函数.
DisableIdentifyAddressDiscovery 禁用使用对等点在identify中提供的观察地址进行地址发现 如果你预先知道你的公共地址,建议使用AddressFactory为主机提供外部地址,并使用此选项禁用从identify进行的地址发现 参数: - 无
返回: - Option: 配置函数.
DisableMetrics 配置dep2p禁用prometheus指标 返回: - Option: 配置函数.
DisableRelay 配置dep2p禁用中继传输 返回: - Option: 配置函数.
EnableAutoNATv2 启用AutoNAT v2功能 参数: - 无
返回: - Option: 配置函数.
EnableAutoRelay 配置dep2p启用AutoRelay子系统 依赖: - 中继(默认启用) - 以下之一: 1.
EnableAutoRelayWithPeerSource 使用提供的PeerSource回调获取更多中继候选者来配置dep2p启用AutoRelay子系统 当检测到节点公开不可访问时(例如在NAT后面),此子系统执行自动地址重写以通告中继地址 参数: - peerSource: 对等点源回调函数 - opts: AutoRelay选项
返回: - Option: 配置函数.
EnableAutoRelayWithStaticRelays 使用提供的中继作为中继候选者配置dep2p启用AutoRelay子系统 当检测到节点公开不可访问时(例如在NAT后面),此子系统执行自动地址重写以通告中继地址 参数: - static: 静态中继地址信息列表 - opts: AutoRelay选项
返回: - Option: 配置函数.
Experimental EnableHolePunching 通过使NAT后的对等点能够发起和响应打洞尝试来启用NAT穿透,以创建与其他对等点的直接/NAT穿透连接(默认:禁用)
依赖: - 中继(默认启用)
此子系统执行两个功能:
1.
EnableNATService 配置dep2p为对等点提供确定其可达性状态的服务 启用后,主机将尝试回拨对等点,然后告诉它们是否成功建立此类连接 返回: - Option: 配置函数.
EnableRelay 配置dep2p启用中继传输 此选项仅配置dep2p接受来自中继的入站连接,并在远程对等方请求时通过中继进行出站连接 此选项支持circuit v1和v2连接 (默认:启用) 返回: - Option: 配置函数.
EnableRelayService 配置dep2p运行circuit v2中继,如果我们检测到我们是公开可访问的 参数: - opts: 中继选项
返回: - Option: 配置函数.
ForceReachabilityPrivate 覆盖AutoNAT子系统中的自动可达性检测,强制本地节点相信它在NAT后面且外部不可达 返回: - Option: 配置函数.
ForceReachabilityPublic 覆盖AutoNAT子系统中的自动可达性检测,强制本地节点相信它是外部可达的 返回: - Option: 配置函数.
Identity 配置dep2p使用给定的私钥来标识自己 参数: - sk: 私钥
返回: - Option: 配置函数.
IPv6BlackHoleSuccessCounter 配置dep2p使用f作为IPv6地址的黑洞过滤器 参数: - f: *swarm.BlackHoleSuccessCounter 黑洞成功计数器
返回: - Option: 配置函数.
ListenAddrs 配置dep2p监听给定的地址 参数: - addrs: 要监听的multiaddr地址切片
返回: - Option: 配置函数.
ListenAddrStrings 配置dep2p监听给定的(未解析的)地址 参数: - s: 要监听的地址字符串切片
返回: - Option: 配置函数.
MultiaddrResolver 设置dep2p dns解析器 参数: - rslv: multiaddr DNS解析器实现
返回: - Option: 配置函数.
Muxer 配置dep2p使用给定的流多路复用器 参数: - name: 协议名称 - muxer: 多路复用器实现
返回: - Option: 配置函数.
NATManager 配置dep2p使用请求的NATManager 此函数应传入一个接受dep2p Network的NATManager构造函数 参数: - nm: NAT管理器构造函数
返回: - Option: 配置函数.
NATPortMap 配置dep2p使用默认的NATManager 默认NATManager将尝试使用UPnP在网络防火墙中打开端口 返回: - Option: 配置函数.
New 使用给定选项构造一个新的 dep2p 节点,如果没有提供某些选项则使用合理的默认值 默认值包括: - 如果未提供传输和监听地址,节点将监听 "/ip4/0.0.0.0/tcp/0" 和 "/ip6/::/tcp/0" - 如果未提供传输选项,节点使用 TCP、websocket 和 QUIC 传输协议 - 如果未提供多路复用器配置,节点默认使用 yamux - 如果未提供安全传输,主机使用 go-dep2p 的 noise 和/或 tls 加密传输来加密所有流量 - 如果未提供对等身份,它会生成一个随机的 Ed25519 密钥对并从中派生新身份 - 如果未提供对等存储,主机将使用空的对等存储进行初始化
参数: - opts: ...Option 配置选项列表
返回: - host.Host: 新创建的 dep2p 主机 - error: 如果发生错误则返回错误信息.
NewWithoutDefaults 使用给定选项构造新的 dep2p 节点,但不使用默认值 警告: 此函数不应被视为稳定接口 我们可能随时选择添加必需的服务,使用此函数即表示您选择不使用我们可能提供的任何默认值
参数: - opts: ...Option 配置选项列表
返回: - host.Host: 新创建的 dep2p 主机 - error: 如果发生错误则返回错误信息.
Peerstore 配置dep2p使用给定的peerstore 参数: - ps: peerstore实现
返回: - Option: 配置函数.
Ping 配置dep2p支持ping服务;默认启用 参数: - enable: 是否启用ping
返回: - Option: 配置函数.
PrivateNetwork 配置dep2p使用给定的私有网络保护器 参数: - psk: 预共享密钥
返回: - Option: 配置函数.
PrometheusRegisterer 配置dep2p使用reg作为所有指标子系统的注册器 参数: - reg: prometheus注册器
返回: - Option: 配置函数.
ProtocolVersion 设置dep2p Identify协议所需的协议版本字符串 参数: - s: 协议版本字符串
返回: - Option: 配置函数.
QUICReuse 配置QUIC传输的地址重用 参数: - constructor: QUIC构造函数 - opts: QUIC选项
返回: - Option: 配置函数.
ResourceManager 配置dep2p使用给定的ResourceManager 当使用p2p/host/resource-manager实现ResourceManager接口时,建议通过调用SetDefaultServiceLimits为dep2p协议设置限制 参数: - rcmgr: 资源管理器实现
返回: - Option: 配置函数.
Routing 配置dep2p使用路由 参数: - rt: 路由构造函数
返回: - Option: 配置函数.
Security 配置dep2p使用给定的安全传输(或传输构造函数) 参数: - name: 协议名称 - constructor: 传输构造函数,可以是已构造的security.Transport或一个函数,该函数可以接受以下任意参数: - 公钥 - 私钥 - Peer ID - Host - Network - Peerstore
返回: - Option: 配置函数.
SetDefaultServiceLimits 为内置的 dep2p 服务设置默认限制 参数: - config: *rcmgr.ScalingLimitConfig 资源限制配置对象.
ShareTCPListener 在TCP和Websocket传输之间共享相同的监听地址,这允许两种传输使用相同的TCP端口 目前此行为是可选的。在未来的版本中,这将成为默认行为,此选项将被移除 参数: - 无
返回: - Option: 配置函数.
SwarmOpts 配置dep2p使用带选项的swarm 参数: - opts: swarm选项
返回: - Option: 配置函数.
Transport 配置dep2p使用给定的传输(或传输构造函数) 参数: - constructor: 传输构造函数,可以是已构造的transport.Transport或一个函数,该函数可以接受以下任意参数: - Transport Upgrader (*tptu.Upgrader) - Host - Stream muxer (muxer.Transport) - Security transport (security.Transport) - Private network protector (pnet.Protector) - Peer ID - Private Key - Public Key - Address filter (filter.Filter) - Peerstore - opts: 传输选项
返回: - Option: 配置函数.
UDPBlackHoleSuccessCounter 配置dep2p使用f作为UDP地址的黑洞过滤器 参数: - f: *swarm.BlackHoleSuccessCounter 黑洞成功计数器
返回: - Option: 配置函数.
UserAgent 设置与identify协议一起发送的dep2p用户代理 参数: - userAgent: 用户代理字符串
返回: - Option: 配置函数.
WithDialTimeout 设置拨号超时时间 参数: - t: 超时时间
返回: - Option: 配置函数.
WithFxOption 添加用户提供的fx.Option到dep2p构造函数中 实验性功能:此选项可能会更改或删除 参数: - opts: ...fx.Option fx选项列表
返回: - Option: 配置函数.
# Variables
DefaultConnectionManager 创建默认的连接管理器 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
DefaultEnableRelay 默认启用中继拨号和监听 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
DefaultListenAddrs 配置 dep2p 使用默认的监听地址 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
DefaultMuxers 配置 dep2p 使用流连接多路复用器 当需要扩展而不是替换 dep2p 使用的多路复用器时使用此选项.
DefaultPeerstore 配置 dep2p 使用默认的对等点存储 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
DefaultPrivateTransports 是提供 PSK 时默认的 dep2p 传输配置 当需要扩展而不是替换 dep2p 使用的传输时使用此选项.
DefaultPrometheusRegisterer 配置dep2p使用默认的Prometheus注册器 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
DefaultResourceManager 配置默认的资源管理器 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
Defaults 配置dep2p使用默认选项 可以与其他选项组合以扩展默认选项 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
DefaultSecurity 是默认的安全选项配置 当需要扩展而不是替换支持的传输安全协议时很有用.
DefaultTransports 是默认的 dep2p 传输配置 当需要扩展而不是替换 dep2p 使用的传输时使用此选项.
FallbackDefaults 仅在未应用其他相关选项时才应用默认选项 将被附加到传递给New的选项中 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.
NoListenAddrs 配置dep2p默认不监听
这将清除任何已配置的监听地址并防止dep2p应用默认监听地址选项 它还禁用中继,除非用户通过选项显式指定,因为传输会创建一个隐式监听地址,使节点可以通过它连接的任何中继进行拨号.
NoSecurity 是一个完全禁用所有传输安全的选项 它与所有其他传输安全协议不兼容.
NoTransports 配置dep2p不启用任何传输
这将清除任何已配置的传输(在先前的dep2p选项中指定)并防止dep2p应用默认传输.
RandomIdentity 生成随机身份(默认行为) 参数: - cfg: *Config 配置对象
返回: - error: 如果发生错误则返回错误信息.