aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/SUMMARY.md
Commit message (Collapse)AuthorAge
* docs: pipe documentationGarrett D'Amore2025-01-14
| | | | While here addressed some minor issues with http docs as well.
* http: The big HTTP API refactoring of January 2025.v2.0.0-alpha.3http-client-transGarrett D'Amore2025-01-09
| | | | | | | | | | | | | | | | | | | | | | This represents a major change in the HTTP code base, consisting of a complete revamp of the HTTP API. The changes here are too numerous to mention, but the end result should be a vastly simpler API for both server and client applications. Many needless allocations were removed by providing fixed buffers for various parameters and headers when possible. A few bugs were fixed. Most especially we have fixed some bugs around very large URIs and headers, and we have also addressed conformance bugs to more closely conform to RFCs 9110 and 9112. As part of this work, the APIs for WebSockets changed slightly as well. In particular the properties available for accessing headers have changed. There is still documentation conversion work to do, and additional functionality (such as proper support for chunked transfers), but this is a big step in the right direction.
* args: Convert nng_opts_parse into a header only library using `nng_args_parse`.Garrett D'Amore2025-01-04
| | | | | | | | The API is identical, except that some names have changed, and this is now a header library in `nng/args.h` - so the core library does not need to carry this code in binaries. Being a header library also means it is not necessary to link against NNG, and it does not include any parts of NNG; it only depends on a standard C99 or C11 environment.
* docs: convert the context docs to mdbookGarrett D'Amore2025-01-01
|
* docs: start of streams API documentationGarrett D'Amore2024-12-31
|
* Document nng_init and nng_finiGarrett D'Amore2024-11-11
|
* fixes #1914 Document nng_socket_proto_id, proto_name, peer_id, peer_name, ↵Garrett D'Amore2024-11-09
| | | | and nng_socket_raw
* 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: 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: move migration docs into bookGarrett D'Amore2024-10-22
|
* docs: messages API converted to single chapter.Garrett D'Amore2024-10-22
|
* docs: fix clock cross referencesGarrett D'Amore2024-10-20
|
* docs: Move time related functions into single chapter.Garrett D'Amore2024-10-20
|
* docs: thread converted to new styleGarrett D'Amore2024-10-20
|
* Synchronization primitives made a single chapter in mdbook.Garrett D'Amore2024-10-20
|
* docs: statistics as a single chapter.Garrett D'Amore2024-10-19
|
* Logging as a single chapter.Garrett D'Amore2024-10-19
| | | | | | | | | | | | | This is the direction we want to go with documentation. Major areas of functionality should be one single chapter in the API reference, which should make them far more usable for people not already familiar with NNG. This represents a substantial departure from UNIX man pages, but many of our users are not used to working with UNIX man pages anyway, and organization of man pages, while convenient for reading with the legacy shell man command, fails on a number of usability fronts.
* Conversion of nng_aio to mdbook in progressGarrett D'Amore2024-10-19
|
* IPC transport converted to mdbook.Garrett D'Amore2024-10-18
|
* Stats API converted to mdbook.Garrett D'Amore2024-10-15
| | | | | A number of small errors were fixed, and we tried to restructure this to be a bit more usable to readers.
* log documentation converted to mdbook.Garrett D'Amore2024-10-14
|
* Converted protocols to mdbook.Garrett D'Amore2024-10-14
| | | | Started an introductory section too.
* doc: nng_url converted to mdbook.Garrett D'Amore2024-10-13
|
* docs: nng_msg_pipe converted to mdbookGarrett D'Amore2024-10-13
|
* mdbook: Add some front matter material.Garrett D'Amore2024-10-13
|
* nng_msg_header and company converted to mdbookGarrett D'Amore2024-10-12
|
* nng message header converted to mdbookGarrett D'Amore2024-10-12
|
* nng_msg docs converted to mdbookGarrett D'Amore2024-10-12
| | | | | We're moving to fewer man pages, with related functions grouped together in the same man page, and this continues the trend.
* Convert inproc doc to mdbook.Garrett D'Amore2024-10-11
|
* Convert nng_duration to mdbook.Garrett D'Amore2024-10-11
|
* nng_opts_parse converted to mdbook.Garrett D'Amore2024-10-11
|
* Convert thread documentation to mdbook. Also conslidate this man page.Garrett D'Amore2024-10-11
|
* more mdbook stuffGarrett D'Amore2024-10-11
|
* Convert nng_socket_pair.Garrett D'Amore2024-10-11
| | | | Also some cleanups on the organization of the mdbook.
* Converted condition variable docs to mdbook.Garrett D'Amore2024-10-11
| | | | | This also is implemented using a single unified manual page that should be easier to reference.
* Converted nng_strdup and nng_strfree to mdbook.Garrett D'Amore2024-10-06
|
* Convert nng_strerror to mdbook.Garrett D'Amore2024-10-06
|
* Convert nng_alloc and nng_free to mdbook.Garrett D'Amore2024-10-06
|
* nng_version converted to mdbookGarrett D'Amore2024-10-06
|
* Convert nng_random to new format.Garrett D'Amore2024-10-06
|
* Initial swag at UDP transport docs, also converted socket transport to mdbookGarrett D'Amore2024-10-06
| | | | This has a lot of TODO links, because there are missing pieces still of course.
* Convert nng_clock and nng_msleep docs to mdbookGarrett D'Amore2024-10-06
|
* Docs for mutexes converted.Garrett D'Amore2024-10-06
|
* idmap public docs converted to mdbookGarrett D'Amore2024-10-06