package pstoremem

Import Path
	github.com/libp2p/go-libp2p/p2p/host/peerstore/pstoremem (on go.dev)

Dependency Relation
	imports 19 packages, and imported by 3 packages

Involved Source Files

	    addr_book.go
	    keybook.go
	    metadata.go
	    peerstore.go
	    protobook.go
	    sorting.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type AddrBookOption (func)

		As Outputs Of (at least 3)
			func WithClock(clock clock) AddrBookOption
			func WithMaxAddresses(n int) AddrBookOption
			func WithMaxSignedPeerRecords(n int) AddrBookOption
		As Inputs Of (at least one exported)
			func NewAddrBook(opts ...AddrBookOption) *memoryAddrBook

	 type AddrSubManager (struct)
		An abstracted, pub-sub manager for address streams. Extracted from
		memoryAddrBook in order to support additional implementations.

		Methods (total 2)
			(*AddrSubManager) AddrStream(ctx context.Context, p peer.ID, initial []ma.Multiaddr) <-chan ma.Multiaddr
				AddrStream creates a new subscription for a given peer ID, pre-populating the
				channel with any addresses we might already have on file.

			(*AddrSubManager) BroadcastAddr(p peer.ID, addr ma.Multiaddr)
				BroadcastAddr broadcasts a new address to all subscribed streams.

		As Outputs Of (at least one exported)
			func NewAddrSubManager() *AddrSubManager

	 type Option (interface)

		As Inputs Of (at least one exported)
			func NewPeerstore(opts ...Option) (ps *pstoremem, err error)

	 type ProtoBookOption (func)

		As Outputs Of (at least one exported)
			func WithMaxProtocols(num int) ProtoBookOption
		As Inputs Of (at least one exported)
			func NewProtoBook(opts ...ProtoBookOption) (*memoryProtoBook, error)


Package-Level Functions (total 10)

	 func NewAddrBook(opts ...AddrBookOption) *memoryAddrBook
	 func NewAddrSubManager() *AddrSubManager
		NewAddrSubManager initializes an AddrSubManager.

	 func NewKeyBook() *memoryKeyBook
	 func NewPeerMetadata() *memoryPeerMetadata
	 func NewPeerstore(opts ...Option) (ps *pstoremem, err error)
		NewPeerstore creates an in-memory thread-safe collection of peers.
		It's the caller's responsibility to call RemovePeer to ensure
		that memory consumption of the peerstore doesn't grow unboundedly.

	 func NewProtoBook(opts ...ProtoBookOption) (*memoryProtoBook, error)
	 func WithClock(clock clock) AddrBookOption
	 func WithMaxAddresses(n int) AddrBookOption
		WithMaxAddresses sets the maximum number of unconnected addresses to store.
		The maximum number of connected addresses is bounded by the connection
		limits in the Connection Manager and Resource Manager.

	 func WithMaxProtocols(num int) ProtoBookOption
	 func WithMaxSignedPeerRecords(n int) AddrBookOption

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.