Updates

zeromq · Aug 13, 2024 · 189e6b0 · 189e6b0
1 parent cd26cad
commit 189e6b0
Show file tree

Hide file tree

Showing 33 changed files with 144 additions and 139 deletions.
diff --git a/assets/highlight.css b/assets/highlight.css
diff --git a/classes/Context.html b/classes/Context.html
diff --git a/classes/Dealer.html b/classes/Dealer.html
diff --git a/classes/Observer.html b/classes/Observer.html
diff --git a/classes/Pair.html b/classes/Pair.html
diff --git a/classes/Proxy.html b/classes/Proxy.html
diff --git a/classes/Publisher.html b/classes/Publisher.html
diff --git a/classes/Pull.html b/classes/Pull.html
diff --git a/classes/Push.html b/classes/Push.html
diff --git a/classes/Reply.html b/classes/Reply.html
diff --git a/classes/Request.html b/classes/Request.html
diff --git a/classes/Router.html b/classes/Router.html
diff --git a/classes/Socket.html b/classes/Socket.html
diff --git a/classes/Stream.html b/classes/Stream.html
diff --git a/classes/Subscriber.html b/classes/Subscriber.html
diff --git a/classes/XPublisher.html b/classes/XPublisher.html
diff --git a/classes/XSubscriber.html b/classes/XSubscriber.html
diff --git a/functions/curveKeyPair.html b/functions/curveKeyPair.html
@@ -1 +1 @@
-<!doctypehtml><html class=default lang=en><meta charset=utf-8><meta http-equiv=x-ua-compatible content="IE=edge"><title>curveKeyPair | zeromq.js</title><meta name=description content="Documentation for zeromq.js"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=stylesheet href=../assets/style.css><link rel=stylesheet href=../assets/highlight.css><script defer=defer src=../assets/main.js></script><script async src=../assets/icons.js id=tsd-icons-script></script><script async src=../assets/search.js id=tsd-search-script></script><script async src=../assets/navigation.js id=tsd-nav-script></script><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os",document.body.style.display="none",setTimeout(()=>app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class=tsd-page-toolbar><div class="tsd-toolbar-contents container"><div class=table-cell id=tsd-search data-base=..><div class=field><label for=tsd-search-field class="tsd-widget tsd-toolbar-icon search no-caption"><svg width=16 height=16 viewBox="0 0 16 16"fill=none><use href=../assets/icons.svg#icon-search></use></svg></label><input type=text id=tsd-search-field aria-label=Search></div><div class=field><div id=tsd-toolbar-links></div></div><ul class=results><li class="state loading">Preparing search index...<li class="state failure">The search index is not available</ul><a href=../index.html class=title>zeromq.js</a></div><div class=table-cell id=tsd-widgets><a href=# class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle=menu aria-label=Menu><svg width=16 height=16 viewBox="0 0 16 16"fill=none><use href=../assets/icons.svg#icon-menu></use></svg></a></div></div></header><div class="container container-main"><div class=col-content><div class=tsd-page-title><ul class=tsd-breadcrumb><li><a href=../modules.html>zeromq.js</a><li><a href=curveKeyPair.html>curveKeyPair</a></ul><h1>Function curveKeyPair</h1></div><section class=tsd-panel><ul class=tsd-signatures><li class="tsd-signature tsd-anchor-link"><a id=curveKeyPair class=tsd-anchor></a><span class=tsd-kind-call-signature>curve<wbr>Key<wbr>Pair</span><span class=tsd-signature-symbol>(</span><span class=tsd-signature-symbol>)</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-symbol>{</span><br><span>    </span><span class=tsd-kind-property>publicKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span>    </span><span class=tsd-kind-property>secretKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span class=tsd-signature-symbol>}</span><a href=#curveKeyPair aria-label=Permalink class=tsd-anchor-icon><svg viewBox="0 0 24 24"><use href=../assets/icons.svg#icon-anchor></use></svg></a><li class=tsd-description><div class="tsd-comment tsd-typography"><p>Returns a new random key pair to be used with the CURVE security mechanism.<p>To correctly connect two sockets with this mechanism:<ul><li>Generate a <strong>client</strong> keypair with <a href=curveKeyPair.html class=tsd-kind-function>curveKeyPair</a>().<ul><li>Assign the private and public key on the client socket with <a href=../classes/Socket.html#curveSecretKey class=tsd-kind-property>Socket.curveSecretKey</a> and <a href=../classes/Socket.html#curvePublicKey class=tsd-kind-property>Socket.curvePublicKey</a>.</ul><li>Generate a <strong>server</strong> keypair with <a href=curveKeyPair.html class=tsd-kind-function>curveKeyPair</a>().<ul><li>Assign the private key on the server socket with <a href=../classes/Socket.html#curveSecretKey class=tsd-kind-property>Socket.curveSecretKey</a>.<li>Assign the public key <strong>on the client socket</strong> with <a href=../classes/Socket.html#curveServerKey class=tsd-kind-property>Socket.curveServerKey</a>. The server does <em>not</em> need to know its own public key. Key distribution is <em>not</em> handled by the CURVE security mechanism.</ul></ul></div><h4 class=tsd-returns-title>Returns <span class=tsd-signature-symbol>{</span><br><span>    </span><span class=tsd-kind-property>publicKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span>    </span><span class=tsd-kind-property>secretKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span class=tsd-signature-symbol>}</span></h4><p>An object with a <code>publicKey</code> and a <code>secretKey</code> property, each being a 40 character Z85-encoded string.<ul class=tsd-parameters><li class=tsd-parameter><h5><span class=tsd-kind-property>public<wbr>Key</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span></h5><li class=tsd-parameter><h5><span class=tsd-kind-property>secret<wbr>Key</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span></h5></ul><div class="tsd-comment tsd-typography"></div><aside class=tsd-sources><ul><li>Defined in <a href=https://github.com/zeromq/zeromq.js/blob/828ed2854162ec6ec58473989dcda081209983f5/src/native.ts#L59>native.ts:59</a></ul></aside></ul></section></div><div class=col-sidebar><div class=page-menu><div class="tsd-navigation settings"><details class=tsd-index-accordion><summary class=tsd-accordion-summary><h3><svg width=20 height=20 viewBox="0 0 24 24"fill=none><use href=../assets/icons.svg#icon-chevronDown></use></svg>Settings</h3></summary><div class=tsd-accordion-details><div class=tsd-filter-visibility><h4 class=uppercase>Member Visibility</h4><form><ul id=tsd-filter-options><li class=tsd-filter-item><label class=tsd-filter-input><input type=checkbox id=tsd-filter-protected name=protected><svg width=32 height=32 viewBox="0 0 32 32"aria-hidden=true><rect class=tsd-checkbox-background width=30 height=30 x=1 y=1 rx=6 fill=none></rect><path class=tsd-checkbox-checkmark d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"stroke=none stroke-width=3.5 stroke-linejoin=round fill=none></path></svg><span>Protected</span></label><li class=tsd-filter-item><label class=tsd-filter-input><input type=checkbox id=tsd-filter-inherited name=inherited checked=checked><svg width=32 height=32 viewBox="0 0 32 32"aria-hidden=true><rect class=tsd-checkbox-background width=30 height=30 x=1 y=1 rx=6 fill=none></rect><path class=tsd-checkbox-checkmark d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"stroke=none stroke-width=3.5 stroke-linejoin=round fill=none></path></svg><span>Inherited</span></label><li class=tsd-filter-item><label class=tsd-filter-input><input type=checkbox id=tsd-filter-external name=external><svg width=32 height=32 viewBox="0 0 32 32"aria-hidden=true><rect class=tsd-checkbox-background width=30 height=30 x=1 y=1 rx=6 fill=none></rect><path class=tsd-checkbox-checkmark d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"stroke=none stroke-width=3.5 stroke-linejoin=round fill=none></path></svg><span>External</span></label></ul></form></div><div class=tsd-theme-toggle><h4 class=uppercase>Theme</h4><select id=tsd-theme><option value=os>OS<option value=light>Light<option value=dark>Dark</select></div></div></details></div></div><div class=site-menu><nav class=tsd-navigation><a href=../modules.html><svg class=tsd-kind-icon viewBox="0 0 24 24"><use href=../assets/icons.svg#icon-1></use></svg><span>zeromq.js</span></a><ul class=tsd-small-nested-navigation id=tsd-nav-container data-base=..><li>Loading...</ul></nav></div></div></div><footer><p class=tsd-generator>Generated using <a href=https://typedoc.org/ target=_blank>TypeDoc</a></footer><div class=overlay></div>
+<!doctypehtml><html class=default lang=en><meta charset=utf-8><meta http-equiv=x-ua-compatible content="IE=edge"><title>curveKeyPair | zeromq.js</title><meta name=description content="Documentation for zeromq.js"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=stylesheet href=../assets/style.css><link rel=stylesheet href=../assets/highlight.css><script defer=defer src=../assets/main.js></script><script async src=../assets/icons.js id=tsd-icons-script></script><script async src=../assets/search.js id=tsd-search-script></script><script async src=../assets/navigation.js id=tsd-nav-script></script><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os",document.body.style.display="none",setTimeout(()=>app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class=tsd-page-toolbar><div class="tsd-toolbar-contents container"><div class=table-cell id=tsd-search data-base=..><div class=field><label for=tsd-search-field class="tsd-widget tsd-toolbar-icon search no-caption"><svg width=16 height=16 viewBox="0 0 16 16"fill=none><use href=../assets/icons.svg#icon-search></use></svg></label><input type=text id=tsd-search-field aria-label=Search></div><div class=field><div id=tsd-toolbar-links></div></div><ul class=results><li class="state loading">Preparing search index...<li class="state failure">The search index is not available</ul><a href=../index.html class=title>zeromq.js</a></div><div class=table-cell id=tsd-widgets><a href=# class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle=menu aria-label=Menu><svg width=16 height=16 viewBox="0 0 16 16"fill=none><use href=../assets/icons.svg#icon-menu></use></svg></a></div></div></header><div class="container container-main"><div class=col-content><div class=tsd-page-title><ul class=tsd-breadcrumb><li><a href=../modules.html>zeromq.js</a><li><a href=curveKeyPair.html>curveKeyPair</a></ul><h1>Function curveKeyPair</h1></div><section class=tsd-panel><ul class=tsd-signatures><li class="tsd-signature tsd-anchor-link"><a id=curveKeyPair class=tsd-anchor></a><span class=tsd-kind-call-signature>curve<wbr>Key<wbr>Pair</span><span class=tsd-signature-symbol>(</span><span class=tsd-signature-symbol>)</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-symbol>{</span><br><span>    </span><span class=tsd-kind-property>publicKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span>    </span><span class=tsd-kind-property>secretKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span class=tsd-signature-symbol>}</span><a href=#curveKeyPair aria-label=Permalink class=tsd-anchor-icon><svg viewBox="0 0 24 24"><use href=../assets/icons.svg#icon-anchor></use></svg></a><li class=tsd-description><div class="tsd-comment tsd-typography"><p>Returns a new random key pair to be used with the CURVE security mechanism.<p>To correctly connect two sockets with this mechanism:<ul><li>Generate a <strong>client</strong> keypair with <a href=curveKeyPair.html class=tsd-kind-function>curveKeyPair</a>().<ul><li>Assign the private and public key on the client socket with <a href=../classes/Socket.html#curveSecretKey class=tsd-kind-property>Socket.curveSecretKey</a> and <a href=../classes/Socket.html#curvePublicKey class=tsd-kind-property>Socket.curvePublicKey</a>.</ul><li>Generate a <strong>server</strong> keypair with <a href=curveKeyPair.html class=tsd-kind-function>curveKeyPair</a>().<ul><li>Assign the private key on the server socket with <a href=../classes/Socket.html#curveSecretKey class=tsd-kind-property>Socket.curveSecretKey</a>.<li>Assign the public key <strong>on the client socket</strong> with <a href=../classes/Socket.html#curveServerKey class=tsd-kind-property>Socket.curveServerKey</a>. The server does <em>not</em> need to know its own public key. Key distribution is <em>not</em> handled by the CURVE security mechanism.</ul></ul></div><h4 class=tsd-returns-title>Returns <span class=tsd-signature-symbol>{</span><br><span>    </span><span class=tsd-kind-property>publicKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span>    </span><span class=tsd-kind-property>secretKey</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span><span class=tsd-signature-symbol>;</span><br><span class=tsd-signature-symbol>}</span></h4><p>An object with a <code>publicKey</code> and a <code>secretKey</code> property, each being a 40 character Z85-encoded string.<ul class=tsd-parameters><li class=tsd-parameter><h5><span class=tsd-kind-property>public<wbr>Key</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span></h5><li class=tsd-parameter><h5><span class=tsd-kind-property>secret<wbr>Key</span><span class=tsd-signature-symbol>: </span><span class=tsd-signature-type>string</span></h5></ul><div class="tsd-comment tsd-typography"></div><aside class=tsd-sources><ul><li>Defined in <a href=https://github.com/zeromq/zeromq.js/blob/c3d466697ee880c66678723f80b0abd3c5105c10/src/native.ts#L59>native.ts:59</a></ul></aside></ul></section></div><div class=col-sidebar><div class=page-menu><div class="tsd-navigation settings"><details class=tsd-index-accordion><summary class=tsd-accordion-summary><h3><svg width=20 height=20 viewBox="0 0 24 24"fill=none><use href=../assets/icons.svg#icon-chevronDown></use></svg>Settings</h3></summary><div class=tsd-accordion-details><div class=tsd-filter-visibility><h4 class=uppercase>Member Visibility</h4><form><ul id=tsd-filter-options><li class=tsd-filter-item><label class=tsd-filter-input><input type=checkbox id=tsd-filter-protected name=protected><svg width=32 height=32 viewBox="0 0 32 32"aria-hidden=true><rect class=tsd-checkbox-background width=30 height=30 x=1 y=1 rx=6 fill=none></rect><path class=tsd-checkbox-checkmark d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"stroke=none stroke-width=3.5 stroke-linejoin=round fill=none></path></svg><span>Protected</span></label><li class=tsd-filter-item><label class=tsd-filter-input><input type=checkbox id=tsd-filter-inherited name=inherited checked=checked><svg width=32 height=32 viewBox="0 0 32 32"aria-hidden=true><rect class=tsd-checkbox-background width=30 height=30 x=1 y=1 rx=6 fill=none></rect><path class=tsd-checkbox-checkmark d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"stroke=none stroke-width=3.5 stroke-linejoin=round fill=none></path></svg><span>Inherited</span></label><li class=tsd-filter-item><label class=tsd-filter-input><input type=checkbox id=tsd-filter-external name=external><svg width=32 height=32 viewBox="0 0 32 32"aria-hidden=true><rect class=tsd-checkbox-background width=30 height=30 x=1 y=1 rx=6 fill=none></rect><path class=tsd-checkbox-checkmark d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"stroke=none stroke-width=3.5 stroke-linejoin=round fill=none></path></svg><span>External</span></label></ul></form></div><div class=tsd-theme-toggle><h4 class=uppercase>Theme</h4><select id=tsd-theme><option value=os>OS<option value=light>Light<option value=dark>Dark</select></div></div></details></div></div><div class=site-menu><nav class=tsd-navigation><a href=../modules.html><svg class=tsd-kind-icon viewBox="0 0 24 24"><use href=../assets/icons.svg#icon-1></use></svg><span>zeromq.js</span></a><ul class=tsd-small-nested-navigation id=tsd-nav-container data-base=..><li>Loading...</ul></nav></div></div></div><footer><p class=tsd-generator>Generated using <a href=https://typedoc.org/ target=_blank>TypeDoc</a></footer><div class=overlay></div>