identify

Documentation

Index

• Constants
• type IDService
  • func NewIDService(h host.Host) *IDService
  • func (ids *IDService) IdentifyConn(c inet.Conn)
  • func (ids *IDService) IdentifyWait(c inet.Conn) <-chan struct{}
  • func (ids *IDService) OwnObservedAddrs() []ma.Multiaddr
  • func (ids *IDService) RequestHandler(s inet.Stream)
  • func (ids *IDService) ResponseHandler(s inet.Stream)
• type ObservedAddr
• type ObservedAddrSet
  • func (oas *ObservedAddrSet) Add(addr ma.Multiaddr, observer ma.Multiaddr)
  • func (oas *ObservedAddrSet) Addrs() []ma.Multiaddr
  • func (oas *ObservedAddrSet) SetTTL(ttl time.Duration)
  • func (oas *ObservedAddrSet) TTL() time.Duration

Constants

const ClientVersion = "go-ipfs/" + config.CurrentVersionNumber

const ID = "/ipfs/identify"

ID is the protocol.ID of the Identify Service.

const IpfsVersion = "ipfs/0.1.0"

IpfsVersion holds the current protocol version for a client running this code TODO(jbenet): fix the versioning mess.

Types

type IDService

type IDService struct {
	Host host.Host
	// 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) *IDService

func (*IDService) IdentifyConn

func (ids *IDService) IdentifyConn(c inet.Conn)

func (*IDService) IdentifyWait

func (ids *IDService) IdentifyWait(c inet.Conn) <-chan struct{}

IdentifyWait returns a channel which will be closed once "ProtocolIdentify" (handshake3) finishes on given conn. This happens async so the connection can start to be used even if handshake3 knowledge is not necesary. Users **MUST** call IdentifyWait _after_ IdentifyConn

func (*IDService) OwnObservedAddrs

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

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

func (*IDService) RequestHandler

func (ids *IDService) RequestHandler(s inet.Stream)

func (*IDService) ResponseHandler

func (ids *IDService) ResponseHandler(s inet.Stream)

type ObservedAddr

type ObservedAddr struct {
	Addr     ma.Multiaddr
	SeenBy   map[string]struct{}
	LastSeen time.Time
}

ObservedAddr is an entry for an address reported by our peers. We only use addresses that:

• have been observed more than once. (counter symmetric nats)
• have been observed recently (10min), because our position in the network, or network port mapppings, may have changed.

type ObservedAddrSet

type ObservedAddrSet struct {
	sync.Mutex // guards whole datastruct.
	// contains filtered or unexported fields
}

ObservedAddrSet keeps track of a set of ObservedAddrs the zero-value is ready to be used.

func (*ObservedAddrSet) Add

func (oas *ObservedAddrSet) Add(addr ma.Multiaddr, observer ma.Multiaddr)

func (*ObservedAddrSet) Addrs

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

func (*ObservedAddrSet) SetTTL

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

func (*ObservedAddrSet) TTL

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