summaryrefslogtreecommitdiff
path: root/docs/man
Commit message (Collapse)AuthorAge
* api: introduce NNG 2.0 compatible nng_dialer_get_url and nng_listener_get_urlGarrett D'Amore2025-01-04
| | | | This is meant to help applications start adopting new interfaces before converting to NNG 2.0
* stable: docs: note deprecation of NNG_FLAG_ALLOCGarrett D'Amore2025-01-03
|
* stable: add nng_socket_close to aid transition to 2.0Garrett D'Amore2025-01-03
|
* Add nng_sub0_subscribe and friends.Garrett D'Amore2024-11-11
| | | | | | These are new functions that replace `NNG_OPT_SUBSCRIBE` and `NNG_OPT_UNSUBSCRIBE`. They are provided here as a transition aid before those options are removed in NNG 2.0.
* Add new functions for socket identity.Garrett D'Amore2024-11-11
| | | | | | | | | | These functions were added in the main branch for NNG 2.0, and we add them here to facilitate converting any code that happened to use the options (`NNG_OPT_PROTO`, `NNG_OPT_PROTONAME`, `NNG_OPT_PEER`, `NNG_OPT_PEERNAME`, and `NNG_OPT_RAW`. Its unlikely that many applications need this, but providing these as a transition aid may help applications start adopting new APIs now.
* Document a number of things as deprecated.Garrett D'Amore2024-11-07
| | | | | This does not fully mark them in the headers, to avoid complicating test suites and such, for now.
* fixes #1851 fix error in NNG_OPT_UNSUBSCRIBE descriptionGarrett D'Amore2024-08-14
|
* idhash: add nng_id_visit APIGarrett D'Amore2024-08-11
| | | | | | This allows an efficient way to iterate over the entries stored in an ID hash. The iteration is fast, and requires no additional storage. The order of iteration is not guaranteed.
* fixes #1846 Add support for TLS PSKGarrett D'Amore2024-07-21
| | | | | | This also adds an SP layer transport test for TLS, based on the TCP test but with some additions; this test does not cover all the edge cases for TLS, but it does at least show how to use it.
* Move the rest of the functionality from platform.h into core.Garrett D'Amore2024-04-23
| | | | This also deprecates supplemental/util/platform.h.
* Move some supplemental APIs to reduce friction in using them.Garrett D'Amore2024-04-23
| | | | | | The supplemental/util/platform.h is kind of a pain, so we move move the prototypes for commonly used functions out of there, into nng.h proper.
* Logging improvements (#1816)Garrett D'Amore2024-04-21
| | | | | | | | | | | | * Add nng_str_sockaddr to get string representation of socket address. * Added nng_log_get_level() is meant to allow users to obtain the current level and avoid some possibly expensive operations just to collect debugging information when debugging is not in effect. We use a custom logger for NUTS, and this fits within the NUTS test framework well, so that if -v is supplied we get more content. All tests now get this by default.
* Add clarification about logged content.Garrett D'Amore2024-04-14
|
* fixes #543 Add logging support frameworkGarrett D'Amore2024-04-13
|
* Update nng_ctx.5.adocBrian Carcich2024-03-16
| | | Fix typos in example.
* Language changes for the nng_socket manual page.Garrett D'Amore2024-02-17
| | | | Thanks to @shikokuchuo for pointing this out.
* fix idhash not publicGarrett D'Amore2024-01-06
| | | | | | | | | We accidentally made idhash not public by not publishing its header in the right place. This is really generic utility stuff, so we have posted it in the nng/supplemental/util/ directory. We've also removed the ability to remove this -- its a very small amount of additional code, as its just a wrapper on top of mandatory functionality.
* Update references to legacy APIs.Garrett D'Amore2024-01-01
|
* fixes #1754 nng_aio_stop.3 refers to `nng_aio_schedule()` instead of ↵Garrett D'Amore2024-01-01
| | | | `nng_aio_begin()`
* s/NNG_DUR_/NNG_DURATION_Patrik Wenger2024-01-01
|
* fix grammarPatrik Wenger2024-01-01
|
* fixes #1751 Support nng_aio_set_expire().Garrett D'Amore2023-12-30
| | | | While here fixed a number of nits in comments.
* Incorrect doc section.Garrett D'Amore2023-12-30
|
* minor grammar fixGarrett D'Amore2023-12-30
|
* trivial wording fixGarrett D'Amore2023-12-30
|
* fixes #1740 Public ID hash APIGarrett D'Amore2023-12-29
| | | | | | | | | This includes a manual page documenting the entire set of functions in one step. The hash is 64-bit based for now, to be maximally flexible. An internal 32-bit convenience for the common internal use is also provided (not public). The public API includes a test suite.
* fixes #1746 Create a new socket:// transport for socketpair() based connectionsGarrett D'Amore2023-12-29
| | | | | | | | | | | | | This transport only listens, and creates connections when the application calls setopt on the lister with NNG_OPT_SOCKET_FD, to pass a file descriptor. The FD is turned into an nng_stream, and utilized for SP. The protocol over the descriptor is identical to the TCP protocol (not the IPC protocol). The options for peer information are borrowed from the IPC transport, as they may be useful for these purposes. This includes a test suite and full documentation.
* fixes #1663 Request/Reply Protocol Throughput and ScalabilityGarrett D'Amore2023-12-16
| | | | | | | | | | | | | | | This eliminates the req protocols use of nni_timer (and setting a single timer node per request. This was problematic because it devolves into O(n^2) as we wind up inserting timer nodes and having to scan the list for the timer node. The solution is to use a single scan - stop worrying about insertion, but instead use a coarse granularity timer (defaults to 1 second) for retries. Then do the O(n) scan just once per interval. A new option, NNG_OPT_REQ_RESENDTICK, can be used to change the tick interval for cases (like unit tests) where more fine grained timing is required.
* fix copyright from last commitGarrett D'Amore2023-12-15
|
* fixes #1721 docs should indicate nng_aio_wait must not be used from a callbackGarrett D'Amore2023-12-15
|
* fixes #1665 docs: document restriction for pipe notify callbacksGarrett D'Amore2023-11-26
| | | | | One must not attempt to use any functions that access the socket directly from pipe notification callbacks.
* docs: add a reference to nng_deviceGarrett D'Amore2023-11-26
|
* [fixed] fix description of function nng_http_handler_collect_body()alawn-wang2023-11-25
|
* nng_aio_stop documentation is badly incorrectGarrett D'Amore2023-09-14
| | | | | The documentation for this function had not been updated in a long time, and reflected behavior that is incorrect.
* fix typo in nng_thread_set_name docPaulo Henrique Silva2023-08-27
| | | | function name was wrong in the code snippet.
* Get common name and subject alternative names of peer certificate (#1617)Christian Fischbach2023-02-08
| | | Co-authored-by: Christian Fischbach <cfischbach@mac.com>
* fixes #1574 Non-blocking version of nng_aio_wait / nng_aio_resultGarrett D'Amore2022-04-18
| | | | | | | This introduces a new API, nng_aio_busy(), that can be used to query the status of the aio without blocking. Some minor documentation fixes are included.
* fixes #1577 nng_stat_find_socket always returns the same stats nodeGarrett D'Amore2022-04-16
| | | | | Also this fixes problems with uninitialized socket names, and the socket name stat not being adjusted correctly when set via API.
* Introduce nng_device_aio().Garrett D'Amore2021-12-27
| | | | | | This function is like nng_device(), but runs asynchronously. Also, this fixes #1503 nng_device causes nng_close to blocking
* fixes #1536 nng_sendmsg and nng_recvmsg could be fasterGarrett D'Amore2021-11-28
| | | | fixes #1535 Desire nng_ctx_sendmsg and nng_ctx_recvmsg
* Fix premature transport registration. Mark it deprecated.Garrett D'Amore2021-08-01
| | | | | | | Originally the idea was to better support having the transports be separate loadable modules. This isn't needed for the builtin transports, so we make the explicit initialization of them deprecated, and document it as such.
* Fix typo. (#1479)Arthur A. Gleckler2021-07-24
|
* Add & document msg_capacity, msg_reserve (#1458)Evan Balster2021-07-06
| | | | | | | * Add & document msg_capacity, msg_reserve * reserve/capacity code style * Documentation references to reserve/capacity
* fixes #1428 Clarify disallowed operations in AIO completion callbacksGarrett D'Amore2021-06-02
|
* fixes #1445 PUB socket buffers, but docs say it should notGarrett D'Amore2021-06-02
|
* fixes #1450 nng_cv_until documentation bugGarrett D'Amore2021-06-02
|
* fixes #1452 nng_aio_set_iov doc bug regarding max IOV countGarrett D'Amore2021-06-02
|
* fixes #972 Very slow pull/push performance compared to ZMQGarrett D'Amore2020-12-27
| | | | | | | | | | This refactors the pipeline protocol to use lightweight mq instead of the more expensive message queue structure. It also provides nicer backpressure and buffering support. The test suite was updated and converted to NUTS as well. This won't completely close the gap, but it should help quite a bit.
* fixes #1313 support deferred nng_aio destructionGarrett D'Amore2020-12-12
|
* fixes #1071 tran_chkopt can be cleaned upGarrett D'Amore2020-11-15
| | | | | | | | | | | | | | | | | This is a sweeping cleanup of the transport logic around options, and also harmonizes the names used when setting or getting options. Additionally, legacy methods are now moved into a separate file and can be elided via CMake or a preprocessor define. Fundamentally, the ability to set to transport options via the socket is deprecated; there are numerous problems with this and my earlier approaches to deal with this have been somewhat misguided. Further these approaches will not work with future protocol work that is planned (were some options need to be negotiated with peers at the time of connection establishment.) Documentation has been updated to reflect this. The test suites still make rather broad use of the older APIs, and will be converted later.