pstoremem

Documentation

Index

• func NewAddrBook(opts ...AddrBookOption) *memoryAddrBook
• func NewKeyBook() *memoryKeyBook
• func NewPeerMetadata() *memoryPeerMetadata
• func NewPeerstore(opts ...Option) (ps *pstoremem, err error)
• func NewProtoBook(opts ...ProtoBookOption) (*memoryProtoBook, error)
• type AddrBookOption
  • func WithClock(clock clock) AddrBookOption
  • func WithMaxAddresses(n int) AddrBookOption
  • func WithMaxSignedPeerRecords(n int) AddrBookOption
• type AddrSubManager
  • func NewAddrSubManager() *AddrSubManager
  • func (mgr *AddrSubManager) AddrStream(ctx context.Context, p peer.ID, initial []ma.Multiaddr) <-chan ma.Multiaddr
  • func (mgr *AddrSubManager) BroadcastAddr(p peer.ID, addr ma.Multiaddr)
• type Option
• type ProtoBookOption
  • func WithMaxProtocols(num int) ProtoBookOption

Functions

func NewAddrBook

func NewAddrBook(opts ...AddrBookOption) *memoryAddrBook

NewAddrBook 创建新的地址簿 参数:

• opts: 地址簿选项

返回:

• *memoryAddrBook: 新创建的地址簿

func NewKeyBook

func NewKeyBook() *memoryKeyBook

NewKeyBook 创建新的内存密钥簿 返回:

• *memoryKeyBook: 内存密钥簿实例

func NewPeerMetadata

func NewPeerMetadata() *memoryPeerMetadata

NewPeerMetadata 创建新的内存对等节点元数据实例 返回:

• *memoryPeerMetadata: 内存对等节点元数据实例

func NewPeerstore

func NewPeerstore(opts ...Option) (ps *pstoremem, err error)

NewPeerstore 创建一个内存中的线程安全的对等节点集合 NewPeerstore 创建一个内存中的线程安全的对等节点集合。 调用者需要负责调用 RemovePeer 以确保对等节点存储的内存消耗不会无限增长。 参数:

• opts: 可选的配置选项

返回:

• *pstoremem: 内存对等节点存储实例
• error: 错误信息

func NewProtoBook

func NewProtoBook(opts ...ProtoBookOption) (*memoryProtoBook, error)

NewProtoBook 创建新的内存协议簿 参数:

• opts: 可选的配置选项

返回:

• *memoryProtoBook: 内存协议簿实例
• error: 错误信息

Types

type AddrBookOption

type AddrBookOption func(book *memoryAddrBook) error

AddrBookOption 地址簿选项函数类型

func WithClock

func WithClock(clock clock) AddrBookOption

WithClock 设置时钟选项 参数:

• clock: 时钟接口

返回:

• AddrBookOption: 地址簿选项函数

func WithMaxAddresses

func WithMaxAddresses(n int) AddrBookOption

WithMaxAddresses 设置最大地址数选项 参数:

• n: 最大地址数

返回:

• AddrBookOption: 地址簿选项函数

func WithMaxSignedPeerRecords

func WithMaxSignedPeerRecords(n int) AddrBookOption

WithMaxSignedPeerRecords 设置最大签名对等记录数选项 参数:

• n: 最大签名对等记录数

返回:

• AddrBookOption: 地址簿选项函数

type AddrSubManager

type AddrSubManager struct {
	// contains filtered or unexported fields
}

AddrSubManager 是地址流的抽象发布-订阅管理器。从memoryAddrBook中提取出来以支持额外的实现。

func NewAddrSubManager

func NewAddrSubManager() *AddrSubManager

NewAddrSubManager 初始化一个AddrSubManager 返回:

• *AddrSubManager: 新创建的管理器

func (*AddrSubManager) AddrStream

func (mgr *AddrSubManager) AddrStream(ctx context.Context, p peer.ID, initial []ma.Multiaddr) <-chan ma.Multiaddr

AddrStream 为给定的对等节点ID创建新的订阅,并用我们可能已经存储的任何地址预填充通道 参数:

• ctx: 上下文
• p: 对等节点ID
• initial: 初始地址列表

返回:

• <-chan ma.Multiaddr: 地址通道

func (*AddrSubManager) BroadcastAddr

func (mgr *AddrSubManager) BroadcastAddr(p peer.ID, addr ma.Multiaddr)

BroadcastAddr 向所有订阅的流广播新地址 参数:

• p: 对等节点ID
• addr: 要广播的地址

type Option

type Option interface{}

Option 定义对等节点存储选项接口

type ProtoBookOption

type ProtoBookOption func(book *memoryProtoBook) error

ProtoBookOption 定义协议簿选项函数类型

func WithMaxProtocols

func WithMaxProtocols(num int) ProtoBookOption

WithMaxProtocols 设置最大协议数量的选项 参数:

• num: 最大协议数量

返回:

• ProtoBookOption: 协议簿选项函数