summaryrefslogtreecommitdiff
path: root/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
Unidiff
Diffstat (limited to 'noncore/net/wellenreiter/libwellenreiter/docs/quickintro') (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/net/wellenreiter/libwellenreiter/docs/quickintro88
1 files changed, 0 insertions, 88 deletions
diff --git a/noncore/net/wellenreiter/libwellenreiter/docs/quickintro b/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
deleted file mode 100644
index 97458b7..0000000
--- a/noncore/net/wellenreiter/libwellenreiter/docs/quickintro
+++ b/dev/null
@@ -1,88 +0,0 @@
1
2Name: libwellenreiter
3Author: Martin J. Muench
4
5NOTE: This is just a very short summary of the functions included
6in libwellenreiter, written because a lack of time. The whole
7library will be rewritten with extended documentation and
8test programs.
9
10--
11Wellenreiter types:
12In proto.hh the following type (wl_network_t) is declared:
13
14typedef struct {
15 int net_type; /* 1 = Accesspoint ; 2 = Ad-Hoc */
16 int ssid_len; /* Length of SSID */
17 int channel; /* Channel */
18 int wep; /* 1 = WEP enabled ; 0 = disabled */
19 char mac[64]; /* MAC address of Accesspoint */
20 char bssid[128]; /* BSSID of Accesspoint */
21} wl_network_t;
22
23When a network is found, the structure has to be set and
24sent to the send_network_found() function.
25
26When the GUI receives a found network string it calls the
27get_network_found() function to get its own structure set.
28
29--
30Included functions:
31
32--
33Protocol:
34
35Send a found network to GUI:
36int send_network_found (const char *, int, void *);
37
38The first two arguments are the guihost and the guiport.
39The third is the filled structure (wl_network_t), that will
40be send to the GUI.
41
42Setup structure for found network:
43int get_network_found (void *, const char *);
44
45When the GUI receives a new network found packet it calls
46this function and passes a wl_network_t structure and the
47received buffer. The function will strip the data from
48the buffer and set it to the structure.
49
50--
51Log to syslog/info:
52void wl_loginfo(const char *, ...);
53
54Log to syslog/err:
55void wl_logerr(const char *, ...);
56
57Use like printf() function with format strings and so on.
58
59--
60Setup udp socket for incoming commands:
61int commsock(const char *, int);
62
63Fist argument is the host where it should listen and second
64is the port. Socket is returned, on failure -1 is returned.
65
66
67Recvfrom socket:
68int recv_commsock(int *, char *, int);
69
70First argument is the address of the socket, second is a buffer
71that should be filled in and the third is the maxlength of the
72buffer. On error, -1 is returned, on success the number of
73packet type is returned. (return value should be used with switch
74command, for types see proto.hh)
75
76Send command to udp socket:
77int sendcomm(const char *, int, const char *, ...);
78
79First two arguments are the host and port where the command should
80be send to, followed by buffer that should be send. On error, -1
81is returned.
82
83
84---
85
86Thats it for the moment.
87
88mjm.