summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2000-12-17 19:31:17 +0000
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2000-12-17 19:31:17 +0000
commitac73922c86560cc1fda0fcf2d300ba1743c99182 (patch)
tree825b3ae170fd589662645d9ec8b503b06641899a /doc
parent7b239638e8122799581ab736438e09c19026052a (diff)
downloadgnutls-ac73922c86560cc1fda0fcf2d300ba1743c99182.tar.gz
added some support for non blocking IO and socket flags. Some function
names have been changed.
Diffstat (limited to 'doc')
-rw-r--r--doc/API16
-rw-r--r--doc/TODO7
2 files changed, 17 insertions, 6 deletions
diff --git a/doc/API b/doc/API
index 02f5b08bc8..45d3b4eaa6 100644
--- a/doc/API
+++ b/doc/API
@@ -59,14 +59,26 @@ char* gnutls_strerror(int error);
gnutls_strerror() returns a malloc'ed value thus it must be
freed.
-ssize_t gnutls_send(int cd, GNUTLS_STATE state, void* data, int sizeofdata);
+ssize_t gnutls_write(int cd, GNUTLS_STATE state, void* data, int sizeofdata);
This function has the same semantics as write() has. The only
difference is that is accepts a GNUTLS state.
-ssize_t gnutls_recv(int cd, GNUTLS_STATE state, void* data, int sizeofdata);
+ssize_t gnutls_read(int cd, GNUTLS_STATE state, void* data, int sizeofdata);
This function has the same semantics as read() has. The only
difference is that is accepts a GNUTLS state.
+ssize_t gnutls_recv(int cd, GNUTLS_STATE state, void* data, int sizeofdata, int flags);
+ This function has the same semantics as recv() has. The only
+ difference is that is accepts a GNUTLS state. However the
+ only acceptable flag is currently MSG_DONTWAIT. In that case, or
+ if the socket is set to non blocking IO it will return GNUTLS_E_AGAIN,
+ if there no data in the socket.
+
+ssize_t gnutls_send(int cd, GNUTLS_STATE state, void* data, int sizeofdata, int flags);
+ This function has the same semantics as send() has. The only
+ difference is that is accepts a GNUTLS state. Currently flags cannot
+ be anything except 0.
+
int gnutls_check_pending(GNUTLS_STATE state);
This function checks if there are any data to receive
in the gnutls buffers. Returns the size of that data or 0.
diff --git a/doc/TODO b/doc/TODO
index e8b395c355..4447559bdb 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -1,6 +1,5 @@
-* x509 Certificate API
-* OpenPGP certificate support (through libgcrypt)
+* x509 Certificate API
* Make server work (we need certificate API for that!)
-* Add support for v2.0 init packet (why do that anyway ???)
* Resume old sessions (server side)
-* Non-blocking IO support (send mail to gnutls-dev@gnupg.org if you are interested/want to help)
+* Add support for v2.0 init packet (why do that anyway ???)
+* OpenPGP certificate support (through libgcrypt)