summaryrefslogtreecommitdiff
path: root/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8
Side-by-side diff
Diffstat (limited to 'noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8') (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.824
1 files changed, 24 insertions, 0 deletions
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8 b/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8
new file mode 100644
index 0000000..ebecd82
--- a/dev/null
+++ b/noncore/net/wellenreiter/libwellenreiter/docs/wl_sock.8
@@ -0,0 +1,24 @@
+wl_sock
+
+#include <wellenreiter/wl_sock.hh>
+
+int wl_setupsock(const char *host, int port)
+int wl_send(const char *host, int port, const char *string, ...)
+int wl_recv(int *socket, char *out, int len)
+
+
+wl_setupsock() returns the number of the activated udp socket.
+
+wl_send() sends string to the given host.
+
+wl_recv() checks for incoming data on a socket (created using
+wl_setupsock()). It writes the incoming data to out with a
+maxlen of len.
+
+
+wl_setupsock() returns -1 on error and the number of socket on
+success.
+wl_send() returns -1 on error and 0 on success.
+wl_recv() returns -1 on error and the type of the received packet
+on success.
+