Version: v0.24.2 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Dec 31, 2022 License: MIT Imports: 24 Imported by: 80




View Source
const DefaultProtocolVersion = "ipfs/0.1.0"
View Source
const ID = "/ipfs/id/1.0.0"

ID is the protocol.ID of version 1.0.0 of the identify service.

View Source
const IDDelta = "/p2p/id/delta/1.0.0"
View Source
const IDPush = "/ipfs/id/push/1.0.0"

IDPush is the protocol.ID of the Identify push protocol. It sends full identify messages containing the current state of the peer.

It is in the process of being replaced by identify delta, which sends only diffs for better resource utilisation.

View Source
const ServiceName = "libp2p.identify"


View Source
var ActivationThresh = 4

ActivationThresh sets how many times an address must be seen as "activated" and therefore advertised to other peers as an address that the local peer can be contacted on. The "seen" events expire by default after 40 minutes (OwnObservedAddressTTL * ActivationThreshold). The are cleaned up during the GC rounds set by GCInterval.

View Source
var GCInterval = 10 * time.Minute

GCInterval specicies how often to make a round cleaning seen events and observed addresses. An address will be cleaned if it has not been seen in OwnObservedAddressTTL (10 minutes). A "seen" event will be cleaned up if it is older than OwnObservedAddressTTL * ActivationThresh (40 minutes).

View Source
var StreamReadTimeout = 60 * time.Second

StreamReadTimeout is the read timeout on all incoming Identify family streams.


func HasConsistentTransport

func HasConsistentTransport(a ma.Multiaddr, green []ma.Multiaddr) bool

HasConsistentTransport returns true if the address 'a' shares a protocol set with any address in the green set. This is used to check if a given address might be one of the addresses a peer is listening on.

func NewIDService

func NewIDService(h host.Host, opts ...Option) (*idService, error)

NewIDService constructs a new *idService and activates it by attaching its stream handler to the given host.Host.


type IDService

type IDService interface {
	// IdentifyConn synchronously triggers an identify request on the connection and
	// waits for it to complete. If the connection is being identified by another
	// caller, this call will wait. If the connection has already been identified,
	// it will return immediately.
	// IdentifyWait triggers an identify (if the connection has not already been
	// identified) and returns a channel that is closed when the identify protocol
	// completes.
	IdentifyWait(network.Conn) <-chan struct{}
	// OwnObservedAddrs returns the addresses peers have reported we've dialed from
	OwnObservedAddrs() []ma.Multiaddr
	// ObservedAddrsFor returns the addresses peers have reported we've dialed from,
	// for a specific local address.
	ObservedAddrsFor(local ma.Multiaddr) []ma.Multiaddr

type ObservedAddrManager added in v0.8.2

type ObservedAddrManager struct {
	// contains filtered or unexported fields

ObservedAddrManager keeps track of a ObservedAddrs.

func NewObservedAddrManager added in v0.8.2

func NewObservedAddrManager(host host.Host) (*ObservedAddrManager, error)

NewObservedAddrManager returns a new address manager using peerstore.OwnObservedAddressTTL as the TTL.

func (*ObservedAddrManager) Addrs added in v0.8.2

func (oas *ObservedAddrManager) Addrs() []ma.Multiaddr

Addrs return all activated observed addresses

func (*ObservedAddrManager) AddrsFor added in v0.8.2

func (oas *ObservedAddrManager) AddrsFor(addr ma.Multiaddr) (addrs []ma.Multiaddr)

AddrsFor return all activated observed addresses associated with the given (resolved) listen address.

func (*ObservedAddrManager) Close added in v0.16.0

func (oas *ObservedAddrManager) Close() error

func (*ObservedAddrManager) Record added in v0.8.2

func (oas *ObservedAddrManager) Record(conn network.Conn, observed ma.Multiaddr)

Record records an address observation, if valid.

func (*ObservedAddrManager) SetTTL added in v0.8.2

func (oas *ObservedAddrManager) SetTTL(ttl time.Duration)

SetTTL sets the TTL of an observed address manager.

func (*ObservedAddrManager) TTL added in v0.8.2

func (oas *ObservedAddrManager) TTL() time.Duration

TTL gets the TTL of an observed address manager.

type Option added in v0.4.0

type Option func(*config)

Option is an option function for identify.

func DisableSignedPeerRecord added in v0.9.0

func DisableSignedPeerRecord() Option

DisableSignedPeerRecord disables populating signed peer records on the outgoing Identify response and ONLY sends the unsigned addresses.

func ProtocolVersion added in v0.23.0

func ProtocolVersion(s string) Option

ProtocolVersion sets the protocol version string that will be used to identify the family of protocols used by the peer.

func UserAgent added in v0.4.0

func UserAgent(ua string) Option

UserAgent sets the user agent this node will identify itself with to peers.


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL