peerstore

README

go-libp2p-peerstore

An object to manage peers, their addresses, and other metadata about them.

Install

go get github.com/libp2p/go-libp2p-peerstore

Usage

Check out the GoDocs.

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?

License

MIT

---

The last gx published version of this module was: 2.0.19: QmaCTz9RkrU13bm9kMB54f7atgqM4qkjDZpRwRoJiWXEqs

Documentation

Index

• Constants
• Variables
• func InfoFromP2pAddr(m ma.Multiaddr) (*core.AddrInfo, error)
• func InfoToP2pAddrs(pi *core.AddrInfo) ([]ma.Multiaddr, error)
• func NewMetrics() *metrics
• func NewPeerstore(kb pstore.KeyBook, ab pstore.AddrBook, pb pstore.ProtoBook, ...) pstore.Peerstore
• func PeerInfoIDs(pis []peer.AddrInfo) peer.IDSlice
• func PeerInfos(ps pstore.Peerstore, peers peer.IDSlice) []peer.AddrInfo
• type AddrBook
• type KeyBook
• type Metrics
• type PeerInfo
• type PeerMetadata
• type Peerstore
• type ProtoBook

Constants

const (
	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.PermanentAddrTTL instead.
	PermanentAddrTTL = core.PermanentAddrTTL

	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.ConnectedAddrTTL instead.
	ConnectedAddrTTL = core.ConnectedAddrTTL
)

Variables

var (
	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.AddressTTL instead.
	AddressTTL = core.AddressTTL

	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.TempAddrTTL instead.
	TempAddrTTL = core.TempAddrTTL

	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.ProviderAddrTTL instead.
	ProviderAddrTTL = core.ProviderAddrTTL

	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.RecentlyConnectedAddrTTL instead.
	RecentlyConnectedAddrTTL = core.RecentlyConnectedAddrTTL

	// Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.OwnObservedAddrTTL instead.
	OwnObservedAddrTTL = core.OwnObservedAddrTTL
)

var ErrInvalidAddr = core.ErrInvalidAddr

Deprecated: use github.com/libp2p/go-libp2p-core/peer.ErrInvalidAddr instead.

var ErrNotFound = core.ErrNotFound

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.ErrNotFound instead.

var LatencyEWMASmoothing = 0.1

LatencyEWMASmooting governs the decay of the EWMA (the speed at which it changes). This must be a normalized (0-1) value. 1 is 100% change, 0 is no change.

Functions

func InfoFromP2pAddr

func InfoFromP2pAddr(m ma.Multiaddr) (*core.AddrInfo, error)

Deprecated: use github.com/libp2p/go-libp2p-core/peer.AddrInfoFromP2pAddr instead.

func InfoToP2pAddrs

func InfoToP2pAddrs(pi *core.AddrInfo) ([]ma.Multiaddr, error)

Deprecated: use github.com/libp2p/go-libp2p-core/peer.AddrInfoToP2pAddrs instead.

func NewMetrics

func NewMetrics() *metrics

func NewPeerstore

func NewPeerstore(kb pstore.KeyBook, ab pstore.AddrBook, pb pstore.ProtoBook, md pstore.PeerMetadata) pstore.Peerstore

NewPeerstore creates a data structure that stores peer data, backed by the supplied implementations of KeyBook, AddrBook and PeerMetadata. Deprecated: use pstoreds.NewPeerstore or peerstoremem.NewPeerstore instead.

func PeerInfoIDs

func PeerInfoIDs(pis []peer.AddrInfo) peer.IDSlice

func PeerInfos

func PeerInfos(ps pstore.Peerstore, peers peer.IDSlice) []peer.AddrInfo

Types

type AddrBook

type AddrBook = core.AddrBook

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.AddrBook instead.

type KeyBook

type KeyBook = core.KeyBook

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.KeyBook instead.

type Metrics

type Metrics = core.Metrics

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.Metrics instead.

type PeerInfo

type PeerInfo = core.AddrInfo

Deprecated: use github.com/libp2p/go-libp2p-core/peer.AddrInfo instead.

type PeerMetadata

type PeerMetadata = core.PeerMetadata

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.PeerMetadata instead.

type Peerstore

type Peerstore = core.Peerstore

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.Peerstore instead.

type ProtoBook

type ProtoBook = core.ProtoBook

Deprecated: use github.com/libp2p/go-libp2p-core/peerstore.ProtoBook instead.