]> gitweb.factorcode.org Git - factor.git/commitdiff
io.sockets.secure.openssl: Fix docs
authorDoug Coleman <doug.coleman@gmail.com>
Mon, 20 Dec 2021 08:26:41 +0000 (02:26 -0600)
committerDoug Coleman <doug.coleman@gmail.com>
Mon, 20 Dec 2021 08:26:41 +0000 (02:26 -0600)
basis/io/sockets/secure/openssl/openssl-docs.factor

index 8353cda5598ab95ab13d57b6dc05289ffe16a090..885e3fc2b335187ad684316bcd365b49eb222305 100644 (file)
@@ -27,22 +27,21 @@ HELP: do-ssl-connect
 HELP: do-ssl-read
 { $values
   { "buffer" buffer }
-  { "ssl" SSL }
+  { "ssl-handle" ssl-handle }
   { "event/f" { $maybe "a symbol indicating the desired operation" } } }
 { $description "Reads from the ssl connection to the buffer." } ;
 
 HELP: do-ssl-write
 { $values
   { "buffer" buffer }
-  { "ssl" SSL }
+  { "ssl-handle" ssl-handle }
   { "event/f" { $maybe "a symbol indicating the desired operation" } } }
 { $description "Writes from the buffer to the ssl connection." } ;
 
 HELP: check-ssl-error
 { $values
-  { "ssl" SSL }
+  { "ssl-handle" ssl-handle }
   { "ret" "error code returned by an SSL function" }
-  { "extra-cases/f" { $maybe "an assoc of error codes and quotations" } }
   { "event/f" { $maybe "a symbol indicating the desired operation" } }
 }
 { $description "Checks if the last SSL function returned successfully or not. If so, returns " { $link f } " or a symbol, " { $link +input+ } " or " { $link +output+ } ", that indicates the socket operation required by libssl." } ;