package identify

Import Path
	github.com/libp2p/go-libp2p/p2p/protocol/identify (on go.dev)

Dependency Relation
	imports 31 packages, and imported by 5 packages

Involved Source Files

	    id.go
	    metrics.go
	    nat_emitter.go
	    obsaddr.go
	    opts.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type IDService (interface)

		Methods (total 6)
			( IDService) Close() error
			( IDService) IdentifyConn(network.Conn)
				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.

			( IDService) IdentifyWait(network.Conn) <-chan struct{}
				IdentifyWait triggers an identify (if the connection has not already been
				identified) and returns a channel that is closed when the identify protocol
				completes.

			( IDService) ObservedAddrsFor(local ma.Multiaddr) []ma.Multiaddr
				ObservedAddrsFor returns the addresses peers have reported we've dialed from,
				for a specific local address.

			( IDService) OwnObservedAddrs() []ma.Multiaddr
				OwnObservedAddrs returns the addresses peers have reported we've dialed from

			( IDService) Start()
		Implements (at least 2)
			 IDService : github.com/prometheus/common/expfmt.Closer
			 IDService : io.Closer
		As Outputs Of (at least one exported)
			func github.com/libp2p/go-libp2p/p2p/host/basic.(*BasicHost).IDService() IDService
		As Inputs Of (at least one exported)
			func github.com/libp2p/go-libp2p/p2p/protocol/holepunch.NewService(h host.Host, ids IDService, listenAddrs func() []ma.Multiaddr, opts ...holepunch.Option) (*holepunch.Service, error)

	 type MetricsTracer (interface)

		Methods (total 4)
			( MetricsTracer) ConnPushSupport(identifyPushSupport)
				ConnPushSupport counts peers by Push Support

			( MetricsTracer) IdentifyReceived(isPush bool, numProtocols int, numAddrs int)
				IdentifyReceived tracks metrics on receiving an identify response

			( MetricsTracer) IdentifySent(isPush bool, numProtocols int, numAddrs int)
				IdentifySent tracks metrics on sending an identify response

			( MetricsTracer) TriggeredPushes(event any)
				TriggeredPushes counts IdentifyPushes triggered by event

		As Outputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
		As Inputs Of (at least one exported)
			func WithMetricsTracer(tr MetricsTracer) Option

	 type MetricsTracerOption (func)

		As Outputs Of (at least one exported)
			func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption
		As Inputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer

	 type ObservedAddrManager (struct)
		ObservedAddrManager maps connection's local multiaddrs to their externally observable multiaddress

		Methods (total 4)
			(*ObservedAddrManager) Addrs() []ma.Multiaddr
				Addrs return all activated observed addresses

			(*ObservedAddrManager) AddrsFor(addr ma.Multiaddr) (addrs []ma.Multiaddr)
				AddrsFor return all activated observed addresses associated with the given
				(resolved) listen address.

			(*ObservedAddrManager) Close() error
			(*ObservedAddrManager) Record(conn connMultiaddrs, observed ma.Multiaddr)
				Record enqueues an observation for recording

		Implements (at least 2)
			*ObservedAddrManager : github.com/prometheus/common/expfmt.Closer
			*ObservedAddrManager : io.Closer
		As Outputs Of (at least one exported)
			func NewObservedAddrManager(listenAddrs, hostAddrs func() []ma.Multiaddr, interfaceListenAddrs func() ([]ma.Multiaddr, error), normalize func(ma.Multiaddr) ma.Multiaddr) (*ObservedAddrManager, error)

	 type Option (func)
		Option is an option function for identify.

		As Outputs Of (at least 6)
			func DisableObservedAddrManager() Option
			func DisableSignedPeerRecord() Option
			func ProtocolVersion(s string) Option
			func UserAgent(ua string) Option
			func WithMetricsTracer(tr MetricsTracer) Option
			func WithTimeout(timeout time.Duration) Option
		As Inputs Of (at least one exported)
			func NewIDService(h host.Host, opts ...Option) (*idService, error)


Package-Level Functions (total 11)

	 func DisableObservedAddrManager() Option
		DisableObservedAddrManager disables the observed address manager. It also
		effectively disables the nat emitter and EvtNATDeviceTypeChanged

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

	 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(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.

	 func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
	 func NewObservedAddrManager(listenAddrs, hostAddrs func() []ma.Multiaddr, interfaceListenAddrs func() ([]ma.Multiaddr, error), normalize func(ma.Multiaddr) ma.Multiaddr) (*ObservedAddrManager, error)
		NewObservedAddrManager returns a new address manager using peerstore.OwnObservedAddressTTL as the TTL.

	 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(ua string) Option
		UserAgent sets the user agent this node will identify itself with to peers.

	 func WithMetricsTracer(tr MetricsTracer) Option
	 func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption
	 func WithTimeout(timeout time.Duration) Option
		WithTimeout sets the timeout for identify interactions.


Package-Level Variables (only one)

	  var ActivationThresh int
		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.


Package-Level Constants (total 4)

	const DefaultTimeout time.Duration = 5000000000
		DefaultTimeout for all id interactions, incoming / outgoing, id / id-push.

	const ID = "/ipfs/id/1.0.0"
		ID is the protocol.ID of version 1.0.0 of the identify service.

	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.

	const ServiceName = "libp2p.identify"
		ServiceName is the default identify service name

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.