steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

io.sockets.secure.openssl: more docs

db4
Björn Lindqvist 2014-04-18 18:42:00 +02:00 committed by John Benediktsson
parent e473ef628d
commit df3417c5b7
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
basis/io/sockets/secure/openssl/openssl-docs.factor
View File

@ -1,4 +1,5 @@
USING: help.markup help.syntax kernel strings sequences ;
USING: help.markup help.syntax io.files io.buffers kernel openssl.libssl
strings sequences ;
IN: io.sockets.secure.openssl
HELP: subject-name
@ -18,3 +19,30 @@ HELP: subject-names-match?
HELP: alternative-dns-names
{ $values { "certificate" "an SSL peer certificate" } { "dns-names" sequence } }
{ $description "Alternative subject names for the certificate." } ;
HELP: do-ssl-connect
{ $values { "ssl-handle" ssl-handle } }
{ $description "Connects the SSL handle to the remote server. Blocks until the connection is established or an error is thrown." } ;
HELP: do-ssl-read
{ $values
{ "buffer" buffer }
{ "ssl" SSL }
{ "event/f" "f or a symbol indicating the desired operation" } }
{ $description "Reads from the ssl connection to the buffer." } ;
HELP: do-ssl-write
{ $values
{ "buffer" buffer }
{ "ssl" SSL }
{ "event/f" "f or a symbol indicating the desired operation" } }
{ $description "Writes from the buffer to the ssl connection." } ;
HELP: check-ssl-error
{ $values
{ "ssl" SSL }
{ "ret" "error code returned by an SSL function" }
{ "exra-cases/f" "f or an assoc of error codes and quotations" }
{ "event/f" "f or 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." } ;