Add even more documentation

This commit is contained in:
Christopher Baines 2026-03-18 08:58:41 +00:00
parent d3d4964210
commit 09cb805ee2
5 changed files with 85 additions and 0 deletions

View file

@ -32,6 +32,16 @@
(define* (non-blocking-open-socket-for-uri uri
#:key (verify-certificate? #t))
"Open a socket for URI and return it as a non-blocking port.
For HTTPS URIs the TLS handshake is completed while the socket is
still blocking (required because Guile's TLS wrapper does not support
non-blocking handshakes), then the underlying socket is made
non-blocking. For plain HTTP the socket is made non-blocking
immediately.
@code{#:verify-certificate?} controls TLS certificate verification
and defaults to @code{#t}."
(define tls-wrap
(@@ (web client) tls-wrap))