aboutsummaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAge
* Document HTTP request/reply structures and handling.Garrett D'Amore2018-02-02
|
* Add, and document, the url->u_requri member.Garrett D'Amore2018-02-02
| | | | | This member is the value passed in actual HTTP protocol, so it is useful with the function nng_http_req_set_uri().
* fixes #222 Public URL APIGarrett D'Amore2018-01-23
|
* Add message handling man pages.Garrett D'Amore2018-01-23
| | | | | | Note that we're also no longer overriding the source formatter or the icons for new pages, since we can supply that on the command line in the script that generates output.
* Provide for icons and source formatting from script instead of content.Garrett D'Amore2018-01-23
|
* Better PDF output to work around limitations in asciidoctor.Garrett D'Amore2018-01-23
|
* Add description of URL canonicalization.Garrett D'Amore2018-01-23
|
* Updates to support generation of PDF (pretty) and PostScript (ugly).Garrett D'Amore2018-01-23
| | | | | The preview script also changes to take a "-s <style>" argument instead of single flag switches.
* fixes #221 zerotier URL format changesGarrett D'Amore2018-01-22
| | | | | | We are adopting a more standard URL format for zerotier, and making more use of the URL parsing common layer. While here we updated the docs to reflect correctly the URI syntax we are using everywhere.
* fixes #209 NNG_OPT_TLS_VERIFIED is bustedGarrett D'Amore2018-01-17
| | | | | fixes #210 Want NNG_OPT_TLS_* options for TLS transport fixes #212 Eliminate a_endpt member of aio
* fixes #206 Want NNG_OPT_TLS_VERIFIED optionGarrett D'Amore2018-01-16
| | | | | | | | | | | | | | It is useful to have support for validating that a peer *was* verified, especially in the presence of optional validation. We have added a property that does this, NNG_OPT_TLS_VERIFIED. Further, all the old NNG_OPT_WSS_TLS_* property names have also been renamed to generic NNG_OPT_TLS property names, which have been moved to nng.h to facilitate reuse and sharing, with the comments moved and corrected as well. Finally, the man pages have been updated, with substantial improvements to the nng_ws man page in particular.
* fixes #201 TLS configuration should support files for certificates and keysGarrett D'Amore2018-01-16
| | | | | | | | | | | | | | | | | | | | | | | | | This adds support for configuration of TLS websockets using the files for keys, certificates, and CRLs. Significant changes to the websocket, TLS, and HTTP layers were made here. We now expect TLS configuration to be tied to the HTTP layer, and the HTTP code creates default configuration objects based on the URL supplied. (HTTP dialers and listeners are now created with a URL rather than a sockaddr, giving them access to the scheme as well.) We fixed several bugs affecting TLS validation, and added a test suite that confirms that validation works as it should. We also fixed an orphaned socket during HTTP negotiation, responsible for an occasional assertion error if the http handshake does not complete successfully. Finally several use-after-free races were closed. TLS layer changes include reporting of handshake failures using newly created "standard" error codes for peer authentication and cryptographic failures. The use of the '*' wild card in URLs at bind time is no longer supported for websocket at least. Documentation updates for all this are in place as well.
* fixes #186 Suggested API changes for nng TLS certsGarrett D'Amore2018-01-09
|
* Add reference to pipeline protocol.Garrett D'Amore2018-01-09
|
* fixes #197 surveyor documentation (man pages) incorrectGarrett D'Amore2018-01-09
|
* Add TLS configuration manipulation documentation.Garrett D'Amore2018-01-01
| | | | | | While here, also fixup the markup on many of the pages, to use commas in SEE ALSO, avoid adding the .adoc extension to cross-references, and correct the link to the MIT license text.
* Rename config init/fini to alloc/free, add documentation for them.Garrett D'Amore2017-12-31
|
* Add reference to websocket man page.Garrett D'Amore2017-12-30
|
* fixes #166 Websocket TLS mappingGarrett D'Amore2017-12-30
| | | | | | | | | | | | | | | | | This introduces the wss:// scheme, which is available and works like the ws:// scheme if TLS is enabled in the library. The library modularization is refactored somewhat, to make it easier to use. There is now a single NNG_ENABLE_TLS that enables TLS support under the hood. This also adds a new option for the TLS transport, NNG_OPT_TLS_CONFIG (and a similar one for WSS, NNG_OPT_TLS_WSS_CONFIG) that offer access to the underlying TLS configuration object, which now has a public API to go with it as well. Note that it is also possible to use pure HTTPS using the *private* API, which will be exposed in a public form soon.
* fixes #169 document websocket transportGarrett D'Amore2017-12-27
|
* Fix cut'n'paste typoAndy Kirkham2017-12-12
|
* fixes #160 Convert TLS url from tls:// to tls+tcp://Garrett D'Amore2017-11-27
|
* Add a reference for nng_tls.Garrett D'Amore2017-11-21
|
* fixes #3 TLS transportGarrett D'Amore2017-11-20
| | | | | | | | | | | | | | | | | | | This introduces a new transport (compatible with the TLS transport from mangos), using TLS v1.2. To use the new transport, you must have the mbed TLS library available on your system (Xenial libmbedtls-dev). You can use version 2.x or newer -- 1.3.x and PolarSSL versions are not supported. You enable the TLS transport with -DNNG_TRANSPORT_TLS=ON in the CMake configuration. You must configure the server certificate by default, and this can only be done using nng options. See the nng_tls man page for details. This work is experimental, and was made possible by Capitar IT Group BV, and Staysail Systems, Inc.
* fixes #149 remove AUTHOR section from man pagesGarrett D'Amore2017-11-04
|
* fixes #148 man pages for req/rep protocol neededGarrett D'Amore2017-11-04
|
* fixes #146 man pages for surveyor protocol neededGarrett D'Amore2017-11-03
|
* fixes #143 Protocols and transports should be "configurable"Garrett D'Amore2017-11-02
| | | | | | | | | | | | | | | | | | | | This makes all the protocols and transports optional. All of them except ZeroTier are enabled by default, but you can now disable them (remove from the build) with cmake options. The test suite is modified so that tests still run as much as they can, but skip over things caused by missing functionality from the library (due to configuration). Further, the constant definitions and prototypes for functions that are specific to transports or protocols are moved into appropriate headers, which should be included directly by applications wishing to use these. We have also added and improved documentation -- all of the transports are documented, and several more man pages for protocols have been added. (Req/Rep and Surveyor are still missing.)
* Add nng_bus man page.Garrett D'Amore2017-10-31
|
* fixes #137 Remove public access to numeric protocolsGarrett D'Amore2017-10-31
|
* Fix front matter for man pages.Garrett D'Amore2017-10-30
|
* Minor markup fixes.Garrett D'Amore2017-10-30
|
* New strerror document.Garrett D'Amore2017-10-30
|
* Start of API landing page.Garrett D'Amore2017-10-30
|
* Add conceptual overview doc.Garrett D'Amore2017-10-26
|
* Minor format changes, tie the sleep in preview to script exit.Garrett D'Amore2017-10-26
|
* Documentation updates.Garrett D'Amore2017-10-26
| | | | | | | | | This adds a few man pages, fixes the content and formatting on a few others. It also adds two utility scripts for me to use, publish.sh, which I use to publish updates to the gh-pages branch, and preview.sh, which I use to look at markup without cluttering my work directory.
* Spelling fixes (thanks ispell).Garrett D'Amore2017-10-24
|
* Various man page fixups, add inproc header.Garrett D'Amore2017-10-24
| | | | | | | We added nng_inproc man page, and a header with an explicit registration method for it. We also fixed up the markup on several other pages, and corrected the include statements for nng_zerotier.
* Doc directory moved to make github pages happy.Garrett D'Amore2017-10-24