summaryrefslogtreecommitdiff
path: root/docs/man/nng_setopt.3.adoc
Commit message (Collapse)AuthorAge
* 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.
* fix sections for stat man pagesGarrett D'Amore2020-01-23
|
* fixes #861 Man pages need to use .adoc suffixGarrett D'Amore2019-07-06
|
* fixes #901 shorter option get/set functions for all typesJake Woltersdorf2019-04-07
| | | | | | | | | | | | - Renamed internal nng_*_getx/setx methods with "nni" prefix - Moved stream get/set option definition macros to options.h and added "NNI_" prefix - "_PTR" variant of get/set option definition macros is for when first arg is passed as pointer (`nng_stream *s` vs `nng_pipe s`) - New get/set option functions for `nng_socket` are `nng_socket_get_X` eschewing the previous `nng_getopt` pattern - Macro-fy legacy getopt/setopt and implement in terms of "new" API - nng_setopt* use "new" shorter API. Add missing uint64 set functions. - Shorter get/set option functions get own man page and old getopt/setopt link to them - Built with -DNNG_ENABLE_DOC=ON and part of central libnng index - Update copyright
* Fixes manpage typos (#886)jake-ruyi2019-02-20
|
* Improved layout and wording of option accessor functions.Garrett D'Amore2018-11-08
|
* Fix numerous spelling errrors.Garrett D'Amore2018-05-30
| | | | | | | These were found with the help of "aspell". Additionally, while reviewing the output from the spell checker, several content errors were noticed and fixed.
* 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.
* fixes #301 String option handling for getoptGarrett D'Amore2018-03-20
|
* fixes #293 nng_listener_getopt doc needs updatingGarrett D'Amore2018-03-18
| | | | | Actually I updated all the option related documents, and fixed minor markup issues on several others.
* fixes #295 boolean options should use C99 bool typeGarrett D'Amore2018-03-18
| | | | | | | | | | | fixes #275 nng_pipe_getopt_ptr() missing? fixes #285 nng_setopt_ptr MIS fixes #297 nng_listener/dialer_close does not validate mode This change adds some missing APIs, and changes others. In particular, certain options are now of type bool, with size of just one. This is a *breaking* change for code that uses those options -- NNG_OPT_RAW, NNG_OPT_PAIR1_POLY, NNG_OPT_TLS_VERIFIED.
* 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.)