From bcc61a06e867bc38441dab18bb3e6dfebe3ddfa0 Mon Sep 17 00:00:00 2001 From: jaylin Date: Thu, 28 Dec 2023 22:33:25 +0800 Subject: [PATCH] * SYNC [docs] nanonng docs sync Signed-off-by: wayne Signed-off-by: jaylin --- README.md | 4 +++- docs/man/nng_req.7.adoc | 1 - 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ee51876f..fd550935 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,9 @@ The NanoSDK C client comprises four variant libraries, shared or static: The API documentation is provided in Asciidoc format in the `docs/man` subdirectory -The `docs/man/libnng.3.adoc#,libnng(3)` page is a good starting point. +The <> page provides a conceptual overview and links to +manuals for various patterns. +The <> page is a good starting point for the API reference. In addition, many users would like to add self-defined behavior in the callback of online and offline. Therefore, we modified the callback method of connection and disconnection to allow users to perform blocking and waiting operations in the callback without affecting the MQTT connection & pradigm itself, so as to improve the flexibility of NanoSDK. However, it should be noted that this will consume the number of threads inside the NanoSDK. If the taskq thread is exhausted, it will still affect the operation of the entire client. Please use it cautiously. diff --git a/docs/man/nng_req.7.adoc b/docs/man/nng_req.7.adoc index 1d958562..34aba174 100644 --- a/docs/man/nng_req.7.adoc +++ b/docs/man/nng_req.7.adoc @@ -121,7 +121,6 @@ the clock does not tick at all. + This option is shared for all contexts on a socket, and is only available for the socket itself. - === Protocol Headers (((backtrace)))