identify

Documentation

Index

• Constants
• Variables
• func HasConsistentTransport(a ma.Multiaddr, green []ma.Multiaddr) bool
• type IDService
  • func NewIDService(h host.Host, opts ...Option) (*IDService, error)
  • func (ids *IDService) Close() error
  • func (ids *IDService) IdentifyConn(c network.Conn)
  • func (ids *IDService) IdentifyWait(c network.Conn) <-chan struct{}
  • func (ids *IDService) ObservedAddrsFor(local ma.Multiaddr) []ma.Multiaddr
  • func (ids *IDService) OwnObservedAddrs() []ma.Multiaddr
• type ObservedAddrManager
  • func NewObservedAddrManager(ctx context.Context, host host.Host) (*ObservedAddrManager, error)
  • func (oas *ObservedAddrManager) Addrs() []ma.Multiaddr
  • func (oas *ObservedAddrManager) AddrsFor(addr ma.Multiaddr) (addrs []ma.Multiaddr)
  • func (oas *ObservedAddrManager) Record(conn network.Conn, observed ma.Multiaddr)
  • func (oas *ObservedAddrManager) SetTTL(ttl time.Duration)
  • func (oas *ObservedAddrManager) TTL() time.Duration
• type Option
  • func DisableSignedPeerRecord() Option
  • func UserAgent(ua string) Option

Constants

const ID = "/dms3/id/1.0.0"

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

const IDDelta = "/p2p/id/delta/1.0.0"

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.

const LibP2PVersion = "dms3/0.1.0"

LibP2PVersion holds the current protocol version for a client running this code TODO(jbenet): fix the versioning mess. XXX: Don't change this till 2020. You'll break all go-ipfs versions prior to 0.4.17 which asserted an exact version match.

Variables

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.

var ClientVersion = "gitlab.dms3.io/dms3/public/go-dms3-p2p"

ClientVersion is the default user agent.

Deprecated: Set this with the UserAgent option.

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

var StreamReadTimeout = 60 * time.Second

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

Functions

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.

Types

type IDService

type IDService struct {
	Host      host.Host
	UserAgent string
	// contains filtered or unexported fields
}

IDService is a structure that implements ProtocolIdentify. It is a trivial service that gives the other peer some useful information about the local peer. A sort of hello.

The IDService sends:

• Our IPFS Protocol Version
• Our IPFS Agent Version
• Our public Listen Addresses

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.

func (*IDService) Close

func (ids *IDService) Close() error

Close shuts down the IDService

func (*IDService) IdentifyConn

func (ids *IDService) IdentifyConn(c 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.

func (*IDService) IdentifyWait

func (ids *IDService) IdentifyWait(c 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.

func (*IDService) ObservedAddrsFor

func (ids *IDService) ObservedAddrsFor(local ma.Multiaddr) []ma.Multiaddr

func (*IDService) OwnObservedAddrs

func (ids *IDService) OwnObservedAddrs() []ma.Multiaddr

OwnObservedAddrs returns the addresses peers have reported we've dialed from

type ObservedAddrManager

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

ObservedAddrManager keeps track of a ObservedAddrs.

func NewObservedAddrManager

func NewObservedAddrManager(ctx context.Context, host host.Host) (*ObservedAddrManager, error)

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

func (*ObservedAddrManager) Addrs

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

Addrs return all activated observed addresses

func (*ObservedAddrManager) AddrsFor

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) Record

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

Record records an address observation, if valid.

func (*ObservedAddrManager) SetTTL

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

SetTTL sets the TTL of an observed address manager.

func (*ObservedAddrManager) TTL

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

TTL gets the TTL of an observed address manager.

type Option

type Option func(*config)

Option is an option function for identify.

func DisableSignedPeerRecord

func DisableSignedPeerRecord() Option

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

func UserAgent

func UserAgent(ua string) Option

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