<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--  This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>libp2p/protocols/identify</title>

<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">

<!-- CSS -->
<link rel="stylesheet" type="text/css" href="../../nimdoc.out.css">

<!-- JS -->
<script type="text/javascript" src="../../dochack.js"></script>
</head>
<body>
  <div class="document" id="documentId">
    <div class="container">
      <h1 class="title">libp2p/protocols/identify</h1>
      <div class="row">
  <div class="three columns">
    <div class="theme-select-wrapper">
      <label for="theme-select">Theme:&nbsp;</label>
      <select id="theme-select" onchange="setTheme(this.value)">
        <option value="auto">🌗 Match OS</option>
        <option value="dark">🌑 Dark</option>
        <option value="light">🌕 Light</option>
      </select>
    </div>
    <div id="global-links">
      <ul class="simple">
        <li><a id="indexLink" href="../../theindex.html">Index</a></li>
      </ul>
    </div>
    <div id="searchInputDiv">
      Search: <input type="search" id="searchInput" onkeyup="search()"/>
    </div>
    <div>
      Group by:
      <select onchange="groupBy(this.value)">
        <option value="section">Section</option>
        <option value="type">Type</option>
      </select>
    </div>
    <script type="text/javascript">
function main2() {
	// Create the slider
	var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
	var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
    <label class="theme-switch" for="internalcheckbox">
      <input type="checkbox" id="internalcheckbox">
      <div class="slider round"></div>
    </label>
    &nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);

	var sliderInst = firstSlider.after(newSlider);

	// Restore slider state from storage
	var currentMode = localStorage.getItem('privateMode');
	if (currentMode == "private") {
		document.getElementById("internalcheckbox").checked = true;
	} else {
		hidePrivateProcs();
	}

	document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}

function hidePrivateProcs() {
	var toHide = document.getElementsByClassName("tohide");
	for (var i = 0; i < toHide.length; i++) {
		var pragmas = toHide[i].querySelectorAll("span.Identifier");
		var public = false;
		for (var z = 0; z < pragmas.length; z++) {
			if (pragmas[z].innerText == "public") {
				public = true;
				break;
			}
		}
		if (public == false) {
			toHide[i].style.display = "none";
			toHide[i].classList.add("hidden");
			links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
			for (var y = 0; y < links.length; y++) {
				links[y].parentNode.style.display = "none";
				links[y].parentNode.classList.add("hidden");
			}
		}
	}

	// TOC
	var nestedSections = document.getElementsByClassName("nested-toc-section");
	for (var i = 0; i < nestedSections.length; i++) {
		if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
			nestedSections[i].style.display = "none";
			nestedSections[i].classList.add("hidden");
		}
	}

	var sections = document.getElementsByClassName("simple-toc-section");
	for (var i = 0; i < sections.length; i++) {
		if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
			sections[i].parentNode.style.display = "none";
			sections[i].parentNode.classList.add("hidden");
		}

	}

	// Sections
	var sections = document.getElementsByClassName("section");
	for (var i = 0; i < sections.length; i++) {
		if (sections[i].querySelectorAll(".item > div").length == 0) continue;
		if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
			sections[i].style.display = "none";
			sections[i].classList.add("hidden");
		}

	}
}

function showPrivateProcs() {
	var toHide = Array.from(document.getElementsByClassName("hidden"));
	for (var i = 0; i < toHide.length; i++) {
		toHide[i].style.display = "";
		toHide[i].classList.remove("hidden");
	}
}

function togglePrivateProcs() {
	if (document.getElementById("internalcheckbox").checked) {
		localStorage.setItem('privateMode', 'private');
		showPrivateProcs();
	} else {
		localStorage.setItem('privateMode', 'public');
		hidePrivateProcs();
	}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
  <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    <ul class="simple simple-toc-section">
      <li><a class="reference" href="#Identify" title="Identify = ref object of LPProtocol
  peerInfo*: PeerInfo
  sendSignedPeerRecord*: bool
  observedAddrManager*: ObservedAddrManager">Identify</a></li>
<li><a class="reference" href="#IdentifyError" title="IdentifyError = object of LPError">IdentifyError</a></li>
<li><a class="reference" href="#IdentifyInfo" title="IdentifyInfo {.public.} = object
  pubkey*: Option[PublicKey]
  peerId*: PeerId
  addrs*: seq[MultiAddress]
  observedAddr*: Option[MultiAddress]
  protoVersion*: Option[string]
  agentVersion*: Option[string]
  protos*: seq[string]
  signedPeerRecord*: Option[Envelope]">IdentifyInfo</a></li>
<li><a class="reference" href="#IdentifyNoPubKeyError" title="IdentifyNoPubKeyError = object of IdentifyError">IdentifyNoPubKeyError</a></li>
<li><a class="reference" href="#IdentifyPush" title="IdentifyPush = ref object of LPProtocol">IdentifyPush</a></li>
<li><a class="reference" href="#IdentifyPushHandler" title="IdentifyPushHandler = proc (peer: PeerId; newInfo: IdentifyInfo): Future[void] {.
    gcsafe, raises: [], public().}">IdentifyPushHandler</a></li>
<li><a class="reference" href="#IdentityInvalidMsgError" title="IdentityInvalidMsgError = object of IdentifyError">IdentityInvalidMsgError</a></li>
<li><a class="reference" href="#IdentityNoMatchError" title="IdentityNoMatchError = object of IdentifyError">IdentityNoMatchError</a></li>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    <ul class="simple simple-toc-section">
      <li><a class="reference" href="#AgentVersion" title="AgentVersion = &quot;nim-libp2p/0.0.1&quot;">AgentVersion</a></li>
<li><a class="reference" href="#IdentifyCodec" title="IdentifyCodec = &quot;/ipfs/id/1.0.0&quot;">IdentifyCodec</a></li>
<li><a class="reference" href="#IdentifyPushCodec" title="IdentifyPushCodec = &quot;/ipfs/id/push/1.0.0&quot;">IdentifyPushCodec</a></li>
<li><a class="reference" href="#ProtoVersion" title="ProtoVersion = &quot;ipfs/0.1.0&quot;">ProtoVersion</a></li>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">decodeMsg
  <li><a class="reference" href="#decodeMsg%2Cseq%5Bbyte%5D" title="decodeMsg(buf: seq[byte]): Opt[IdentifyInfo]">decodeMsg(buf: seq[byte]): Opt[IdentifyInfo]</a></li>

</ul>
<ul class="simple nested-toc-section">identify
  <li><a class="reference" href="#identify%2CIdentify%2CConnection%2CPeerId" title="identify(self: Identify; conn: Connection; remotePeerId: PeerId): Future[
    IdentifyInfo]">identify(self: Identify; conn: Connection; remotePeerId: PeerId): Future[
    IdentifyInfo]</a></li>

</ul>
<ul class="simple nested-toc-section">init
  <li><a class="reference" href="#init%2CIdentifyPush" title="init(p: IdentifyPush)">init(p: IdentifyPush)</a></li>

</ul>
<ul class="simple nested-toc-section">new
  <li><a class="reference" href="#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo" title="new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false): T:type">new(T: typedesc[Identify]; peerInfo: PeerInfo; sendSignedPeerRecord = false): T:type</a></li>
<li><a class="reference" href="#new%2Ctypedesc%5BIdentifyPush%5D%2CIdentifyPushHandler" title="new(T: typedesc[IdentifyPush]; handler: IdentifyPushHandler = nil): T:type">new(T: typedesc[IdentifyPush]; handler: IdentifyPushHandler = nil): T:type</a></li>

</ul>
<ul class="simple nested-toc-section">push
  <li><a class="reference" href="#push%2CIdentifyPush%2CPeerInfo%2CConnection" title="push(p: IdentifyPush; peerInfo: PeerInfo; conn: Connection)">push(p: IdentifyPush; peerInfo: PeerInfo; conn: Connection)</a></li>

</ul>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#14" id="64">Methods</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">init
  <li><a class="reference" href="#init.e%2CIdentify" title="init(p: Identify)">init(p: Identify)</a></li>

</ul>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">expandItIMPL
  <li><a class="reference" href="#expandItIMPL.t%2Cauto%2Cstaticstring%2CIdentifyInfo" title="expandItIMPL(record: auto; it_name: static string; it: IdentifyInfo)">expandItIMPL(record: auto; it_name: static string; it: IdentifyInfo)</a></li>

</ul>

    </ul>
  </details>
</li>
<li>
  <a class="reference reference-toplevel" href="#19" id="69">Exports</a>
</li>

</ul>

  </div>
  <div class="nine columns" id="content">
    <a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

    <div id="tocRoot"></div>
    
    <p class="module-desc"><a class="reference external" href="https://docs.libp2p.io/concepts/protocols/#identify">Identify</a> and <a class="reference external" href="https://docs.libp2p.io/concepts/protocols/#identify-push">Push Identify</a> implementation</p>
    <div class="section" id="6">
  <h1><a class="toc-backref" href="#6">Imports</a></h1>
  <dl class="item">
    <a class="reference external" href="../protobuf/minprotobuf.html">../protobuf/minprotobuf</a>, <a class="reference external" href="../peerinfo.html">../peerinfo</a>, <a class="reference external" href="../stream/connection.html">../stream/connection</a>, <a class="reference external" href="../peerid.html">../peerid</a>, <a class="reference external" href="../crypto/crypto.html">../crypto/crypto</a>, <a class="reference external" href="../multiaddress.html">../multiaddress</a>, <a class="reference external" href="protocol.html">protocol</a>, <a class="reference external" href="../utility.html">../utility</a>, <a class="reference external" href="../errors.html">../errors</a>, <a class="reference external" href="../observedaddrmanager.html">../observedaddrmanager</a>
  </dl>
</div>
<div class="section" id="7">
  <h1><a class="toc-backref" href="#7">Types</a></h1>
  <dl class="item">
    <div id="Identify" class="tohide">
<dt><pre><a href="identify.html#Identify"><span class="Identifier">Identify</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="protocol.html#LPProtocol"><span class="Identifier">LPProtocol</span></a>
  <span class="Identifier">peerInfo</span><span class="Operator">*</span><span class="Other">:</span> <a href="../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</span></a>
  <span class="Identifier">sendSignedPeerRecord</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
  <span class="Identifier">observedAddrManager</span><span class="Operator">*</span><span class="Other">:</span> <a href="../observedaddrmanager.html#ObservedAddrManager"><span class="Identifier">ObservedAddrManager</span></a>
</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L56" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L56" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyError" class="tohide">
<dt><pre><a href="identify.html#IdentifyError"><span class="Identifier">IdentifyError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="../errors.html#LPError"><span class="Identifier">LPError</span></a></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L41" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L41" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyInfo" class="tohide">
<dt><pre><a href="identify.html#IdentifyInfo"><span class="Identifier">IdentifyInfo</span></a> {.<span class="Identifier">public</span>.} <span class="Other">=</span> <span class="Keyword">object</span>
  <span class="Identifier">pubkey</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="../crypto/crypto.html#PublicKey"><span class="Identifier">PublicKey</span></a><span class="Other">]</span>
  <span class="Identifier">peerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
  <span class="Identifier">addrs</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span>
  <span class="Identifier">observedAddr</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="../multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span>
  <span class="Identifier">protoVersion</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span>
  <span class="Identifier">agentVersion</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span>
  <span class="Identifier">protos</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span>
  <span class="Identifier">signedPeerRecord</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><a href="../signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">]</span>
</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L46" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L46" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyNoPubKeyError" class="tohide">
<dt><pre><a href="identify.html#IdentifyNoPubKeyError"><span class="Identifier">IdentifyNoPubKeyError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="identify.html#IdentifyError"><span class="Identifier">IdentifyError</span></a></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L44" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L44" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyPush" class="tohide">
<dt><pre><a href="identify.html#IdentifyPush"><span class="Identifier">IdentifyPush</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="protocol.html#LPProtocol"><span class="Identifier">LPProtocol</span></a>
  </pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L67" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L67" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyPushHandler" class="tohide">
<dt><pre><a href="identify.html#IdentifyPushHandler"><span class="Identifier">IdentifyPushHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">peer</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">newInfo</span><span class="Other">:</span> <a href="identify.html#IdentifyInfo"><span class="Identifier">IdentifyInfo</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.
    <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> </span><span class="Identifier">public</span><span class="Other">(</span><span class="Other">)</span>.}</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L61" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L61" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentityInvalidMsgError" class="tohide">
<dt><pre><a href="identify.html#IdentityInvalidMsgError"><span class="Identifier">IdentityInvalidMsgError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="identify.html#IdentifyError"><span class="Identifier">IdentifyError</span></a></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L43" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L43" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentityNoMatchError" class="tohide">
<dt><pre><a href="identify.html#IdentityNoMatchError"><span class="Identifier">IdentityNoMatchError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="identify.html#IdentifyError"><span class="Identifier">IdentifyError</span></a></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L42" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L42" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

  </dl>
</div>
<div class="section" id="10">
  <h1><a class="toc-backref" href="#10">Consts</a></h1>
  <dl class="item">
    <div id="AgentVersion" class="tohide">
<dt><pre><a href="identify.html#AgentVersion"><span class="Identifier">AgentVersion</span></a> <span class="Other">=</span> <span class="StringLit">&quot;nim-libp2p/0.0.1&quot;</span></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L38" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L38" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyCodec" class="tohide">
<dt><pre><a href="identify.html#IdentifyCodec"><span class="Identifier">IdentifyCodec</span></a> <span class="Other">=</span> <span class="StringLit">&quot;/ipfs/id/1.0.0&quot;</span></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L35" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L35" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="IdentifyPushCodec" class="tohide">
<dt><pre><a href="identify.html#IdentifyPushCodec"><span class="Identifier">IdentifyPushCodec</span></a> <span class="Other">=</span> <span class="StringLit">&quot;/ipfs/id/push/1.0.0&quot;</span></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L36" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L36" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="ProtoVersion" class="tohide">
<dt><pre><a href="identify.html#ProtoVersion"><span class="Identifier">ProtoVersion</span></a> <span class="Other">=</span> <span class="StringLit">&quot;ipfs/0.1.0&quot;</span></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L37" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L37" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

  </dl>
</div>
<div class="section" id="12">
  <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <dl class="item">
    <div id="decodeMsg-procs-all">
  <div id="decodeMsg,seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decodeMsg%2Cseq%5Bbyte%5D"><span class="Identifier">decodeMsg</span></a><span class="Other">(</span><span class="Identifier">buf</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><a href="identify.html#IdentifyInfo"><span class="Identifier">IdentifyInfo</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L112" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L112" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>
<div id="identify-procs-all">
  <div id="identify,Identify,Connection,PeerId" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#identify%2CIdentify%2CConnection%2CPeerId"><span class="Identifier">identify</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="identify.html#Identify"><span class="Identifier">Identify</span></a><span class="Other">;</span> <span class="Identifier">conn</span><span class="Other">:</span> <a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">;</span> <span class="Identifier">remotePeerId</span><span class="Other">:</span> <a href="../peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
    <span class="Identifier">IdentifyInfo</span><span class="Other">]</span> {.<span class="Identifier">async</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
                    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L169" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L169" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>
<div id="init-procs-all">
  <div id="init,IdentifyPush" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CIdentifyPush"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="identify.html#IdentifyPush"><span class="Identifier">IdentifyPush</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L200" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L200" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>
<div id="new-procs-all">
  <div id="new,typedesc[Identify],PeerInfo" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BIdentify%5D%2CPeerInfo"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="identify.html#Identify"><span class="Identifier">Identify</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">peerInfo</span><span class="Other">:</span> <a href="../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</span></a><span class="Other">;</span> <span class="Identifier">sendSignedPeerRecord</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span> {.
    <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L139" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L139" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
<div id="new,typedesc[IdentifyPush],IdentifyPushHandler" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BIdentifyPush%5D%2CIdentifyPushHandler"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="identify.html#IdentifyPush"><span class="Identifier">IdentifyPush</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">handler</span><span class="Other">:</span> <a href="identify.html#IdentifyPushHandler"><span class="Identifier">IdentifyPushHandler</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span> {.
    <span class="Identifier">public</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>

Create a IdentifyPush protocol. <tt class="docutils literal"><span class="pre"><span class="Identifier">handler</span></span></tt> will be called every time a peer sends us new <tt class="docutils literal"><span class="pre"><span class="Identifier">PeerInfo</span></span></tt>
<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L193" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L193" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>
<div id="push-procs-all">
  <div id="push,IdentifyPush,PeerInfo,Connection" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#push%2CIdentifyPush%2CPeerInfo%2CConnection"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="identify.html#IdentifyPush"><span class="Identifier">IdentifyPush</span></a><span class="Other">;</span> <span class="Identifier">peerInfo</span><span class="Other">:</span> <a href="../peerinfo.html#PeerInfo"><span class="Identifier">PeerInfo</span></a><span class="Other">;</span> <span class="Identifier">conn</span><span class="Other">:</span> <a href="../stream/connection.html#Connection"><span class="Identifier">Connection</span></a><span class="Other">)</span> {.<span class="Identifier">async</span><span class="Other">,</span>
    <span class="Identifier">public</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>

Send new <tt class="docutils literal"><span class="pre"><span class="Identifier">peerInfo</span></span></tt>s to a connection
<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L229" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L229" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>

  </dl>
</div>
<div class="section" id="14">
  <h1><a class="toc-backref" href="#14">Methods</a></h1>
  <dl class="item">
    <div id="init-methods-all">
  <div id="init.e,Identify" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#init.e%2CIdentify"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="identify.html#Identify"><span class="Identifier">Identify</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L152" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L152" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>

  </dl>
</div>
<div class="section" id="18">
  <h1><a class="toc-backref" href="#18">Templates</a></h1>
  <dl class="item">
    <div id="expandItIMPL-templates-all">
  <div id="expandItIMPL.t,auto,staticstring,IdentifyInfo" class="tohide">
<dt><pre><span class="Keyword">template</span> <a href="#expandItIMPL.t%2Cauto%2Cstaticstring%2CIdentifyInfo"><span class="Identifier">expandItIMPL</span></a><span class="Other">(</span><span class="Identifier">record</span><span class="Other">:</span> <span class="Identifier">auto</span><span class="Other">;</span> <span class="Identifier">it_name</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">it</span><span class="Other">:</span> <a href="identify.html#IdentifyInfo"><span class="Identifier">IdentifyInfo</span></a><span class="Other">)</span></pre></dt>
<dd>


<a href="https://github.com/status-im/nim-libp2p/tree/rdv-advertise/libp2p/protocols/identify.nim#L70" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/protocols/identify.nim#L70" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>

</div>

  </dl>
</div>
<div class="section" id="19">
  <h1><a class="toc-backref" href="#19">Exports</a></h1>
  <dl class="item">
    <a href="../observedaddrmanager.html#$,ObservedAddrManager"><span class="Identifier">$</span></a>, <a href="../observedaddrmanager.html#getMostObservedProtosAndPorts,ObservedAddrManager"><span class="Identifier">getMostObservedProtosAndPorts</span></a>, <a href="../observedaddrmanager.html#ObservedAddrManager"><span class="Identifier">ObservedAddrManager</span></a>, <a href="../observedaddrmanager.html#addObservation,ObservedAddrManager,MultiAddress"><span class="Identifier">addObservation</span></a>, <a href="../observedaddrmanager.html#guessDialableAddr,ObservedAddrManager,MultiAddress"><span class="Identifier">guessDialableAddr</span></a>, <a href="../observedaddrmanager.html#new,typedesc[ObservedAddrManager],int,int"><span class="Identifier">new</span></a>
  </dl>
</div>

  </div>
</div>

      <div class="twelve-columns footer">
        <span class="nim-sprite"></span>
        <br>
        <small style="color: var(--hint);">Made with Nim. Generated: 2023-09-25 14:01:56 UTC</small>
      </div>
    </div>
  </div>
  
  <!-- Google fonts -->
  <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
</body>
</html>