diff options
Diffstat (limited to 'ref/api/init.html')
| -rw-r--r-- | ref/api/init.html | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/ref/api/init.html b/ref/api/init.html index 2446452e..9c305067 100644 --- a/ref/api/init.html +++ b/ref/api/init.html @@ -42,6 +42,17 @@ <script src="../toc.js"></script> </head> <body> + <div id="mdbook-help-container"> + <div id="mdbook-help-popup"> + <h2 class="mdbook-help-title">Keyboard shortcuts</h2> + <div> + <p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p> + <p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p> + <p>Press <kbd>?</kbd> to show this help</p> + <p>Press <kbd>Esc</kbd> to hide this help</p> + </div> + </div> + </div> <div id="body-container"> <!-- Work around some values being stored in localStorage wrapped in quotes --> <script> @@ -119,7 +130,7 @@ <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"> + <button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar"> <i class="fa fa-search"></i> </button> </div> @@ -225,7 +236,7 @@ </style> <h1 id="initialization--finalization"><a class="header" href="#initialization--finalization">Initialization & Finalization</a></h1> <p>This chapter details the function used to initialize -the library before first use, and the funtion used to +the library before first use, and the function used to finalize the library and deallocate any resources used by the library.</p> <h2 id="initialization"><a class="header" href="#initialization">Initialization</a></h2> <pre><code class="language-c">typedef struct { @@ -238,7 +249,7 @@ finalize the library and deallocate any resources used by the library.</p> int16_t num_resolver_threads; } nng_init_params; -extern nng_err nng_init(nng_init_parms *params); +extern nng_err nng_init(nng_init_params *params); </code></pre> <p>Before using other interfaces in this library, it is necessary to initialize the library. The <a name="a001"></a><code>nng_init</code> function performs this initialization.</p> @@ -270,7 +281,7 @@ will be used instead for that value.</p> <p><code>num_task_threads</code> and <code>max_task_threads</code> <br /> Configures the number of threads to use for tasks, which are used principally for completion callbacks. The maximum value can be used to provide an upper limit while still allowing -for a dynamically calculated value to be used, as long as it does not exceeed the maximum.</p> +for a dynamically calculated value to be used, as long as it does not exceed the maximum.</p> </li> <li> <p><code>num_expire_threads</code> and <code>max_expire_threads</code> <br /> @@ -290,7 +301,7 @@ Changes the number of threads used for asynchronous DNS look ups.</p> <h2 id="finalization"><a class="header" href="#finalization">Finalization</a></h2> <pre><code class="language-c">extern void nng_fini(void); </code></pre> -<p>When the consumer is ready to deallocate any resoures allocated by the library, it should call +<p>When the consumer is ready to deallocate any resources allocated by the library, it should call the <a name="a002"></a><code>nng_fini</code> function. Each call to <code>nng_fini</code> should be paired with an earlier call to <a href="/api/init.html#initialization"><code>nng_init</code></a>.</p> <p>After calling <code>nng_fini</code>, the consuming application must not make any other calls to NNG functions, |