aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng.7.adoc
Commit message (Collapse)AuthorAge
* docs: minor cleanupsGarrett D'Amore2025-01-14
|
* 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.
* Converted protocols to mdbook.Garrett D'Amore2024-10-14
| | | | Started an introductory section too.
* 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.
* Harmonize the use of NNG in documentation.Garrett D'Amore2020-06-18
| | | | | NNG is always a noun, never an adjective, and should always be capitalized. We also reduced some unnecessary usages of it.
* Language cleanups in the documentation.Garrett D'Amore2020-06-18
| | | | | | Mostly this is removal of the smart quotes, which were over-used, and misused, and could have been mistaken to be pejorative. A few other minor nits were fixed while here.
* Fix incorrect section header levels.Garrett D'Amore2020-06-18
|
* fixes #861 Man pages need to use .adoc suffixGarrett D'Amore2019-07-06
|
* fixes #858 Document the TLS public APIGarrett D'Amore2019-01-14
| | | | | | | This also includes a number of the documentation improvements. The options document has been broken up into separate pages for each of the transport specific options. We have made various other minor improvements, fixes to markup, and cross-references.
* fixes #495 SEE ALSO should use [align=left]Garrett D'Amore2018-05-29
| | | | | | | | | | | | fixes #494 ERRORS section should use [horizontal] These changes address some basic formatting consistency things, and ultimately (when combined with other tooling changes that are not part of this repo) lead to vastly improved layout in the printed documentation. While here we removed trailing whitespace, and did certain other minor markup tweaks.
* Markup fixes, ensuring links are colored properly.Garrett D'Amore2018-05-01
| | | | | | | | | It turns out that when creating cross references, we need to make any text styling (generally literal characters) outside of the link, to avoid having the styling override the link color. (We prefer to have links colored for ease of use.) While here a few other markup, and actual content, errors were fixed.
* Minor cross reference fixes for v0.8.0.Garrett D'Amore2018-04-12
|
* Minor format fix for raw mode header.Garrett D'Amore2018-04-11
|
* fixes #331 replace NNG_OPT_RAW option with constructorGarrett D'Amore2018-04-04
| | | | | | | | | | | | | This makes the raw mode something that is immutable, determined at socket construction. This is an enabling change for the separate context support coming soon. As a result, this is an API breaking change for users of the raw mode option (NNG_OPT_RAW). There aren't many of them out there. Cooked mode is entirely unaffected. There are changes to tests and documentation included.
* Include a tip about service naming guidelines.Garrett D'Amore2018-03-30
|
* fixes #286 nng_pair0_open (and all others) need man pageGarrett D'Amore2018-03-17
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)