summaryrefslogtreecommitdiff
path: root/newref/book/indexing.html
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-24 20:22:17 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-24 20:22:17 -0700
commit31f8d857f63f7b0889bbe49c316676c4d2e67987 (patch)
tree171c124b5d2ef5a7e567241f8d3492092d16bc81 /newref/book/indexing.html
parentf3b7360bcba06fc107faeed8e917d3042cf4871c (diff)
downloadnng-31f8d857f63f7b0889bbe49c316676c4d2e67987.tar.gz
nng-31f8d857f63f7b0889bbe49c316676c4d2e67987.tar.bz2
nng-31f8d857f63f7b0889bbe49c316676c4d2e67987.zip
Trial of new reference
Diffstat (limited to 'newref/book/indexing.html')
-rw-r--r--newref/book/indexing.html269
1 files changed, 269 insertions, 0 deletions
diff --git a/newref/book/indexing.html b/newref/book/indexing.html
new file mode 100644
index 00000000..1df45934
--- /dev/null
+++ b/newref/book/indexing.html
@@ -0,0 +1,269 @@
+<!DOCTYPE HTML>
+<html lang="en" class="light" dir="ltr">
+ <head>
+ <!-- Book generated using mdBook -->
+ <meta charset="UTF-8">
+ <title>Index - NNG Reference Manual</title>
+
+
+ <!-- Custom HTML head -->
+
+ <meta name="description" content="">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <meta name="theme-color" content="#ffffff">
+
+ <link rel="icon" href="favicon.svg">
+ <link rel="shortcut icon" href="favicon.png">
+ <link rel="stylesheet" href="css/variables.css">
+ <link rel="stylesheet" href="css/general.css">
+ <link rel="stylesheet" href="css/chrome.css">
+ <link rel="stylesheet" href="css/print.css" media="print">
+
+ <!-- Fonts -->
+ <link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
+ <link rel="stylesheet" href="fonts/fonts.css">
+
+ <!-- Highlight.js Stylesheets -->
+ <link rel="stylesheet" href="highlight.css">
+ <link rel="stylesheet" href="tomorrow-night.css">
+ <link rel="stylesheet" href="ayu-highlight.css">
+
+ <!-- Custom theme stylesheets -->
+
+ </head>
+ <body class="sidebar-visible no-js">
+ <div id="body-container">
+ <!-- Provide site root to javascript -->
+ <script>
+ var path_to_root = "";
+ var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
+ </script>
+
+ <!-- Work around some values being stored in localStorage wrapped in quotes -->
+ <script>
+ try {
+ var theme = localStorage.getItem('mdbook-theme');
+ var sidebar = localStorage.getItem('mdbook-sidebar');
+
+ if (theme.startsWith('"') && theme.endsWith('"')) {
+ localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
+ }
+
+ if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
+ localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
+ }
+ } catch (e) { }
+ </script>
+
+ <!-- Set the theme before any content is loaded, prevents flash -->
+ <script>
+ var theme;
+ try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
+ if (theme === null || theme === undefined) { theme = default_theme; }
+ var html = document.querySelector('html');
+ html.classList.remove('light')
+ html.classList.add(theme);
+ var body = document.querySelector('body');
+ body.classList.remove('no-js')
+ body.classList.add('js');
+ </script>
+
+ <input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
+
+ <!-- Hide / unhide sidebar before it is displayed -->
+ <script>
+ var body = document.querySelector('body');
+ var sidebar = null;
+ var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
+ if (document.body.clientWidth >= 1080) {
+ try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
+ sidebar = sidebar || 'visible';
+ } else {
+ sidebar = 'hidden';
+ }
+ sidebar_toggle.checked = sidebar === 'visible';
+ body.classList.remove('sidebar-visible');
+ body.classList.add("sidebar-" + sidebar);
+ </script>
+
+ <nav id="sidebar" class="sidebar" aria-label="Table of contents">
+ <div class="sidebar-scrollbox">
+ <ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html"><strong aria-hidden="true">1.</strong> Chapter 1</a></li><li class="chapter-item expanded "><a href="overview/index.html"><strong aria-hidden="true">2.</strong> Overview</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="overview/raw.html"><strong aria-hidden="true">2.1.</strong> RAW mode</a></li></ol></li><li class="chapter-item expanded "><a href="protocols/index.html"><strong aria-hidden="true">3.</strong> Protocols</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="protocols/bus.html"><strong aria-hidden="true">3.1.</strong> BUS</a></li><li class="chapter-item "><a href="protocols/rep.html"><strong aria-hidden="true">3.2.</strong> REP</a></li></ol></li><li class="chapter-item expanded "><a href="transports/index.html"><strong aria-hidden="true">4.</strong> Transports</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="transports/inproc.html"><strong aria-hidden="true">4.1.</strong> INPROC</a></li><li class="chapter-item "><a href="transports/tcp.html"><strong aria-hidden="true">4.2.</strong> TCP</a></li></ol></li><li class="chapter-item expanded "><a href="api/index.html"><strong aria-hidden="true">5.</strong> API Reference</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="api/aio/index.html"><strong aria-hidden="true">5.1.</strong> Asynchronous I/O</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="api/nng_aio.html"><strong aria-hidden="true">5.1.1.</strong> nng_aio</a></li><li class="chapter-item "><a href="api/nng_aio_abort.html"><strong aria-hidden="true">5.1.2.</strong> nng_aio_abort</a></li><li class="chapter-item "><a href="api/nng_aio_alloc.html"><strong aria-hidden="true">5.1.3.</strong> nng_aio_alloc</a></li><li class="chapter-item "><a href="api/nng_aio_busy.html"><strong aria-hidden="true">5.1.4.</strong> nng_aio_busy</a></li><li class="chapter-item "><a href="api/nng_aio_cancel.html"><strong aria-hidden="true">5.1.5.</strong> nng_aio_cancel</a></li><li class="chapter-item "><a href="api/nng_aio_count.html"><strong aria-hidden="true">5.1.6.</strong> nng_aio_count</a></li><li class="chapter-item "><a href="api/nng_aio_free.html"><strong aria-hidden="true">5.1.7.</strong> nng_aio_free</a></li><li class="chapter-item "><a href="api/nng_aio_get_msg.html"><strong aria-hidden="true">5.1.8.</strong> nng_aio_get_msg</a></li><li class="chapter-item "><a href="api/nng_aio_get_output.html"><strong aria-hidden="true">5.1.9.</strong> nng_aio_get_output</a></li><li class="chapter-item "><a href="api/nng_aio_result.html"><strong aria-hidden="true">5.1.10.</strong> nng_aio_result</a></li><li class="chapter-item "><a href="api/nng_aio_set_input.html"><strong aria-hidden="true">5.1.11.</strong> nng_aio_set_input</a></li><li class="chapter-item "><a href="api/nng_aio_set_iov.html"><strong aria-hidden="true">5.1.12.</strong> nng_aio_set_iov</a></li><li class="chapter-item "><a href="api/nng_aio_set_msg.html"><strong aria-hidden="true">5.1.13.</strong> nng_aio_set_msg</a></li><li class="chapter-item "><a href="api/nng_aio_set_timeout.html"><strong aria-hidden="true">5.1.14.</strong> nng_aio_set_timeout</a></li><li class="chapter-item "><a href="api/nng_aio_stop.html"><strong aria-hidden="true">5.1.15.</strong> nng_aio_stop</a></li><li class="chapter-item "><a href="api/nng_aio_wait.html"><strong aria-hidden="true">5.1.16.</strong> nng_aio_wait</a></li></ol></li><li class="chapter-item "><a href="api/aio_provider.html"><strong aria-hidden="true">5.2.</strong> Asynchronous I/O for Providers</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="api/nng_aio_begin.html"><strong aria-hidden="true">5.2.1.</strong> nng_aio_begin</a></li><li class="chapter-item "><a href="api/nng_aio_defer.html"><strong aria-hidden="true">5.2.2.</strong> nng_aio_defer</a></li><li class="chapter-item "><a href="api/nng_aio_finish.html"><strong aria-hidden="true">5.2.3.</strong> nng_aio_finish</a></li><li class="chapter-item "><a href="api/nng_aio_get_input.html"><strong aria-hidden="true">5.2.4.</strong> nng_aio_get_input</a></li><li class="chapter-item "><a href="api/nng_aio_set_output.html"><strong aria-hidden="true">5.2.5.</strong> nng_aio_set_output</a></li></ol></li><li class="chapter-item "><a href="api/general.html"><strong aria-hidden="true">5.3.</strong> General Purpose Functions</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="api/nng_alloc.html"><strong aria-hidden="true">5.3.1.</strong> nng_alloc</a></li><li class="chapter-item "><a href="api/nng_clock.html"><strong aria-hidden="true">5.3.2.</strong> nng_clock</a></li><li class="chapter-item "><a href="api/nng_cv_alloc.html"><strong aria-hidden="true">5.3.3.</strong> nng_cv_alloc</a></li><li class="chapter-item "><a href="api/nng_cv_free.html"><strong aria-hidden="true">5.3.4.</strong> nng_cv_free</a></li><li class="chapter-item "><a href="api/nng_cv_until.html"><strong aria-hidden="true">5.3.5.</strong> nng_cv_until</a></li><li class="chapter-item "><a href="api/nng_cv_wait.html"><strong aria-hidden="true">5.3.6.</strong> nng_cv_wait</a></li><li class="chapter-item "><a href="api/nng_cv_wake.html"><strong aria-hidden="true">5.3.7.</strong> nng_cv_wake</a></li><li class="chapter-item "><a href="api/nng_cv_wake1.html"><strong aria-hidden="true">5.3.8.</strong> nng_cv_wake1</a></li><li class="chapter-item "><a href="api/nng_free.html"><strong aria-hidden="true">5.3.9.</strong> nng_free</a></li></ol></li><li class="chapter-item "><a href="api/context.html"><strong aria-hidden="true">5.4.</strong> Context Functions</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="api/nng_ctx.html"><strong aria-hidden="true">5.4.1.</strong> nng_ctx</a></li><li class="chapter-item "><a href="api/nng_ctx_close.html"><strong aria-hidden="true">5.4.2.</strong> nng_ctx_close</a></li><li class="chapter-item "><a href="api/nng_ctx_get.html"><strong aria-hidden="true">5.4.3.</strong> nng_ctx_get</a></li><li class="chapter-item "><a href="api/nng_ctx_getopt.html"><strong aria-hidden="true">5.4.4.</strong> nng_ctx_getopt</a></li><li class="chapter-item "><a href="api/nng_ctx_id.html"><strong aria-hidden="true">5.4.5.</strong> nng_ctx_id</a></li><li class="chapter-item "><a href="api/nng_ctx_open.html"><strong aria-hidden="true">5.4.6.</strong> nng_ctx_open</a></li><li class="chapter-item "><a href="api/nng_ctx_recv.html"><strong aria-hidden="true">5.4.7.</strong> nng_ctx_recv</a></li><li class="chapter-item "><a href="api/nng_ctx_recvmsg.html"><strong aria-hidden="true">5.4.8.</strong> nng_ctx_recvmsg</a></li><li class="chapter-item "><a href="api/nng_ctx_send.html"><strong aria-hidden="true">5.4.9.</strong> nng_ctx_send</a></li><li class="chapter-item "><a href="api/nng_ctx_sendmsg.html"><strong aria-hidden="true">5.4.10.</strong> nng_ctx_sendmsg</a></li><li class="chapter-item "><a href="api/nng_ctx_set.html"><strong aria-hidden="true">5.4.11.</strong> nng_ctx_set</a></li><li class="chapter-item "><a href="api/nng_ctx_setopt.html"><strong aria-hidden="true">5.4.12.</strong> nng_ctx_setopt</a></li></ol></li><li class="chapter-item "><a href="api/protocol.html"><strong aria-hidden="true">5.5.</strong> Protocol Sockets</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="api/nng_bus_open.html"><strong aria-hidden="true">5.5.1.</strong> nng_bus_open</a></li><li class="chapter-item "><a href="api/nng_close.html"><strong aria-hidden="true">5.5.2.</strong> nng_close</a></li></ol></li><li class="chapter-item "><a href="api/compat/index.html"><strong aria-hidden="true">5.6.</strong> Legacy Compatibility</a></li></ol></li><li class="chapter-item expanded "><a href="indexing.html" class="active"><strong aria-hidden="true">6.</strong> Index</a></li></ol>
+ </div>
+ <div id="sidebar-resize-handle" class="sidebar-resize-handle">
+ <div class="sidebar-resize-indicator"></div>
+ </div>
+ </nav>
+
+ <!-- Track and set sidebar scroll position -->
+ <script>
+ var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
+ sidebarScrollbox.addEventListener('click', function(e) {
+ if (e.target.tagName === 'A') {
+ sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
+ }
+ }, { passive: true });
+ var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
+ sessionStorage.removeItem('sidebar-scroll');
+ if (sidebarScrollTop) {
+ // preserve sidebar scroll position when navigating via links within sidebar
+ sidebarScrollbox.scrollTop = sidebarScrollTop;
+ } else {
+ // scroll sidebar to current active section when navigating via "next/previous chapter" buttons
+ var activeSection = document.querySelector('#sidebar .active');
+ if (activeSection) {
+ activeSection.scrollIntoView({ block: 'center' });
+ }
+ }
+ </script>
+
+ <div id="page-wrapper" class="page-wrapper">
+
+ <div class="page">
+ <div id="menu-bar-hover-placeholder"></div>
+ <div id="menu-bar" class="menu-bar sticky">
+ <div class="left-buttons">
+ <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
+ <i class="fa fa-bars"></i>
+ </label>
+ <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
+ <i class="fa fa-paint-brush"></i>
+ </button>
+ <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
+ <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
+ </ul>
+ <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
+ <i class="fa fa-search"></i>
+ </button>
+ </div>
+
+ <h1 class="menu-title">NNG Reference Manual</h1>
+
+ <div class="right-buttons">
+ <a href="print.html" title="Print this book" aria-label="Print this book">
+ <i id="print-button" class="fa fa-print"></i>
+ </a>
+
+ </div>
+ </div>
+
+ <div id="search-wrapper" class="hidden">
+ <form id="searchbar-outer" class="searchbar-outer">
+ <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
+ </form>
+ <div id="searchresults-outer" class="searchresults-outer hidden">
+ <div id="searchresults-header" class="searchresults-header"></div>
+ <ul id="searchresults">
+ </ul>
+ </div>
+ </div>
+
+ <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
+ <script>
+ document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
+ document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
+ Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
+ link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
+ });
+ </script>
+
+ <div id="content" class="content">
+ <main>
+ <h1 id="index"><a class="header" href="#index">Index</a></h1>
+<p><em>BUS</em> protocol, <a href="protocols/bus.html#a002">1</a><br/>
+<em>inproc</em> transport, <a href="transports/inproc.html#a003">1</a><br/>
+<em>REP</em> protocol, <a href="protocols/rep.html#a002">1</a><br/>
+<em>tcp</em> transport, <a href="transports/tcp.html#a002">1</a><br/>
+aio, <a href="api/nng_aio.html#a001">1</a><br/>
+asynchronous I/O, <a href="api/nng_aio.html#a002">1</a>, <a href="api/nng_aio_alloc.html#a001">2</a><br/>
+backtrace, <a href="protocols/rep.html#a004">1</a><br/>
+best-effort, <a href="protocols/bus.html#a003">1</a><br/>
+callback, <a href="api/nng_aio_alloc.html#a002">1</a><br/>
+compatibility layer, <a href="api/compat/index.html#a001">1</a><br/>
+concurrent, <a href="api/nng_ctx.html#a002">1</a><br/>
+context, <a href="api/nng_ctx.html#a001">1</a>, <a href="api/nng_ctx_open.html#a001">2</a><br/>
+cooked mode, <a href="overview/raw.html#a001">1</a><br/>
+<code>INADDR_ANY</code>, <a href="transports/tcp.html#a006">1</a><br/>
+intra-process, <a href="transports/inproc.html#a002">1</a><br/>
+legacy applications, <a href="api/compat/index.html#a002">1</a><br/>
+<code>NNG_DURATION_DEFAULT</code>, <a href="api/nng_ctx_get.html#a003">1</a><br/>
+<code>NNG_DURATION_INFINITE</code>, <a href="api/nng_ctx_get.html#a002">1</a><br/>
+options, context, <a href="api/nng_ctx_get.html#a001">1</a>, <a href="api/nng_ctx_set.html#a001">2</a><br/>
+port number, TCP, <a href="transports/tcp.html#a005">1</a><br/>
+protocol, <em>BUS</em>, <a href="protocols/bus.html#a001">1</a><br/>
+protocol, <em>REP</em>, <a href="protocols/rep.html#a001">1</a><br/>
+raw mode, <a href="overview/raw.html#a002">1</a>, <a href="api/nng_ctx.html#a003">2</a>, <a href="api/nng_ctx_open.html#a002">3</a><br/>
+request/reply pattern, <a href="protocols/rep.html#a003">1</a><br/>
+scatter/gather, <a href="api/nng_aio_set_iov.html#a001">1</a><br/>
+TCP/IP, <a href="transports/tcp.html#a003">1</a><br/>
+timeout, <a href="api/nng_aio_set_timeout.html#a001">1</a><br/>
+transport, <em>inproc</em>, <a href="transports/inproc.html#a001">1</a><br/>
+transport, <em>tcp</em>, <a href="transports/tcp.html#a001">1</a><br/>
+URI, <code>inproc://</code>, <a href="transports/inproc.html#a004">1</a><br/>
+URI, <code>tcp://</code>, <a href="transports/tcp.html#a004">1</a><br/></p>
+
+ </main>
+
+ <nav class="nav-wrapper" aria-label="Page navigation">
+ <!-- Mobile navigation buttons -->
+ <a rel="prev" href="api/compat/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+ <div style="clear: both"></div>
+ </nav>
+ </div>
+ </div>
+
+ <nav class="nav-wide-wrapper" aria-label="Page navigation">
+ <a rel="prev" href="api/compat/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+ </nav>
+
+ </div>
+
+ <!-- Livereload script (if served using the cli tool) -->
+ <script>
+ const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+ const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+ const socket = new WebSocket(wsAddress);
+ socket.onmessage = function (event) {
+ if (event.data === "reload") {
+ socket.close();
+ location.reload();
+ }
+ };
+
+ window.onbeforeunload = function() {
+ socket.close();
+ }
+ </script>
+
+
+
+ <script>
+ window.playground_copyable = true;
+ </script>
+
+
+ <script src="elasticlunr.min.js"></script>
+ <script src="mark.min.js"></script>
+ <script src="searcher.js"></script>
+
+ <script src="clipboard.min.js"></script>
+ <script src="highlight.js"></script>
+ <script src="book.js"></script>
+
+ <!-- Custom JS scripts -->
+
+
+ </div>
+ </body>
+</html>
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2026-02-05 05:03:27 +0000