aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api
Commit message (Collapse)AuthorAge
* docs: remove references to asterisk wildcard, other tweaksGarrett D'Amore2025-01-02
|
* docs: document NNG_OPT_MAXTTL, other cleanupsGarrett D'Amore2025-01-02
|
* api: remove unused _uint64 options accessors for contexts and socketsGarrett D'Amore2025-01-01
| | | | Also, clarification and add socket option docs for MAXRECVSZ, RECONNMINT, RECONNMAXT
* docs: convert socket options to mdbookGarrett D'Amore2025-01-01
|
* docs: convert the context docs to mdbookGarrett D'Amore2025-01-01
|
* api: Remove the NNG_FLAG_ALLOCGarrett D'Amore2025-01-01
| | | | | | | | This flag failed to provide real zero copy that it was intended for, and it also involved extra allocations. Further, the API for it was brittle and error prone. Modern code should just work directly with nng_msg structures.
* docs: add missing msg header prototypesGarrett D'Amore2025-01-01
|
* docs: converted and improved stream factory docsGarrett D'Amore2025-01-01
|
* docs: add an example of nng_recv_aio with subv2.0.0-alpha.2Garrett D'Amore2024-12-31
|
* docs: convert socket receive docsGarrett D'Amore2024-12-31
|
* doc: document socket send API, including an exampleGarrett D'Amore2024-12-31
|
* docs: remove stray backtickGarrett D'Amore2024-12-31
|
* docs: convert nng_stream_get familyGarrett D'Amore2024-12-31
|
* socket: rename nng_close to nng_socket_closeGarrett D'Amore2024-12-31
|
* docs: progress on socket document conversionGarrett D'Amore2024-12-31
|
* docs: start of streams API documentationGarrett D'Amore2024-12-31
|
* docs: API chapter index fixesGarrett D'Amore2024-12-31
|
* docs: statistics updates, document nng_stat_parent (fixes #1896)Garrett D'Amore2024-12-31
|
* docs: fix URL documentationGarrett D'Amore2024-12-31
| | | | | | Document `nng_url_resolve_port`, make the structure opaque, fix port numbers to be uint32 (needed for some cases), and fix a missing `const` specifier.
* aio: nng_aio_defer replaced by nng_aio_startGarrett D'Amore2024-12-26
| | | | | This represents an API change, and we remove the nng_aio_begin function as well, introducing the lightweight nng_aio_reset instead.
* aio: introduce NNG_ESTOPPEDGarrett D'Amore2024-12-26
| | | | | | | | | | | This error code results when an AIO is stopped permanently, as a result of nni_aio_close or nni_aio_stop. The associated AIO object cannot be used again. This discrimantes against a file being closed, or a temporary cancellation which might allow the aio to be reused. Consumers must check for this error status in their callbacks, and not resubmit an operation that failed with this error. Doing so, will result in an infinite loop of submit / errors.
* Introduce accessors for nng_url struct and make it opaque.Garrett D'Amore2024-11-18
| | | | | This provides safety by ensuring that applications do not depend on the size or layout of nng_url itself.
* URL refactor part 1.Garrett D'Amore2024-11-18
| | | | | | | This eliminates most (but not all) of the dynamic allocations associated with URL objects. A number of convenience fields on the URL are removed, but we are able to use common buffer for most of the details.
* More url work. Undocument rawurl, and stop using it stats and logs.Garrett D'Amore2024-11-17
| | | | | | | Also expose nng_url_sprintf() for users who need it. This avoids some need to do dynamic memory on some things. Soon the entirety of nng_url will be allocation free in the usual case.
* URL u_port should be a number not a string.Garrett D'Amore2024-11-17
| | | | | | | | | | | The idea here is to reduce the dynamic allocations used for URLs, and also the back and forth with parsing begin strings and port numbers. We always resolve to a port number, and this is easier for everyone. The real goal in the long term is to eliminate dynamic allocation of the URL fields altogether, but that requires a little more work. This is a step in the right direction.
* Document nng_init and nng_finiGarrett D'Amore2024-11-11
|
* fixes #1907 Document the nng_socket_get_send_poll_fd and recv_poll_fdGarrett D'Amore2024-11-09
|
* Remove tabs from docs (expand to 4 spaces) - some renderers cannot cope.Garrett D'Amore2024-11-09
|
* fixes #1914 Document nng_socket_proto_id, proto_name, peer_id, peer_name, ↵Garrett D'Amore2024-11-09
| | | | and nng_socket_raw
* Remove left over single doc pages.Garrett D'Amore2024-11-09
|
* docs: fix message linksGarrett D'Amore2024-10-27
|
* docs: update nng_sleep_aio for mdbookGarrett D'Amore2024-10-27
|
* docs: AIO chapter (consumer only) converted to mdbook.Garrett D'Amore2024-10-24
|
* docs: nng_opts_parse converted to chapter.Garrett D'Amore2024-10-23
|
* docs: document error codesGarrett D'Amore2024-10-23
|
* docs: master cross-reference tableGarrett D'Amore2024-10-22
|
* docs: URL chapterGarrett D'Amore2024-10-22
|
* docs: idmap into its own chapterGarrett D'Amore2024-10-22
|
* docs: consolidate misc chapterGarrett D'Amore2024-10-22
|
* docs: add memory chapterGarrett D'Amore2024-10-22
|
* docs: fix markup snafu in msgm.mdGarrett D'Amore2024-10-22
|
* docs: messages API converted to single chapter.Garrett D'Amore2024-10-22
|
* doc: remove unused index.md for thr/Garrett D'Amore2024-10-21
|
* docs: fix clock cross referencesGarrett D'Amore2024-10-20
|
* docs: Move time related functions into single chapter.Garrett D'Amore2024-10-20
|
* Forgot to commit synch.mdGarrett D'Amore2024-10-20
|
* docs: thread converted to new styleGarrett D'Amore2024-10-20
|
* Use `const` for nng_stat when possible.Garrett D'Amore2024-10-20
| | | | | This should help the compiler enforce checks, and may result in better optimizations.
* Synchronization primitives made a single chapter in mdbook.Garrett D'Amore2024-10-20
|
* docs: statistics as a single chapter.Garrett D'Amore2024-10-19
|