summaryrefslogtreecommitdiff
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/quickintro15
1 files changed, 12 insertions, 3 deletions
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/quickintro b/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
index a027a4e..97458b7 100644
--- a/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
+++ b/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
@@ -32,48 +32,57 @@ Included functions:
--
Protocol:
Send a found network to GUI:
int send_network_found (const char *, int, void *);
The first two arguments are the guihost and the guiport.
The third is the filled structure (wl_network_t), that will
be send to the GUI.
Setup structure for found network:
int get_network_found (void *, const char *);
When the GUI receives a new network found packet it calls
this function and passes a wl_network_t structure and the
received buffer. The function will strip the data from
the buffer and set it to the structure.
--
Log to syslog/info:
void wl_loginfo(const char *, ...);
Log to syslog/err:
void wl_logerr(const char *, ...);
Use like printf() function with format strings and so on.
--
Setup udp socket for incoming commands:
int commsock(const char *, int);
Fist argument is the host where it should listen and second
-is the port.
+is the port. Socket is returned, on failure -1 is returned.
-Return values:
+
+Recvfrom socket:
+int recv_commsock(int *, char *, int);
+
+First argument is the address of the socket, second is a buffer
+that should be filled in and the third is the maxlength of the
+buffer. On error, -1 is returned, on success the number of
+packet type is returned. (return value should be used with switch
+command, for types see proto.hh)
Send command to udp socket:
int sendcomm(const char *, int, const char *, ...);
First two arguments are the host and port where the command should
-be send to, followed by buffer that should be send.
+be send to, followed by buffer that should be send. On error, -1
+is returned.
---
Thats it for the moment.
mjm.