Diffstat (limited to 'noncore/net/wellenreiter/libwellenreiter/docs/quickintro') (more/less context) (ignore whitespace changes)
-rw-r--r-- | noncore/net/wellenreiter/libwellenreiter/docs/quickintro | 88 |
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 | |||
2 | Name: libwellenreiter | ||
3 | Author: Martin J. Muench | ||
4 | |||
5 | NOTE: This is just a very short summary of the functions included | ||
6 | in libwellenreiter, written because a lack of time. The whole | ||
7 | library will be rewritten with extended documentation and | ||
8 | test programs. | ||
9 | |||
10 | -- | ||
11 | Wellenreiter types: | ||
12 | In proto.hh the following type (wl_network_t) is declared: | ||
13 | |||
14 | typedef 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 | |||
23 | When a network is found, the structure has to be set and | ||
24 | sent to the send_network_found() function. | ||
25 | |||
26 | When the GUI receives a found network string it calls the | ||
27 | get_network_found() function to get its own structure set. | ||
28 | |||
29 | -- | ||
30 | Included functions: | ||
31 | |||
32 | -- | ||
33 | Protocol: | ||
34 | |||
35 | Send a found network to GUI: | ||
36 | int send_network_found (const char *, int, void *); | ||
37 | |||
38 | The first two arguments are the guihost and the guiport. | ||
39 | The third is the filled structure (wl_network_t), that will | ||
40 | be send to the GUI. | ||
41 | |||
42 | Setup structure for found network: | ||
43 | int get_network_found (void *, const char *); | ||
44 | |||
45 | When the GUI receives a new network found packet it calls | ||
46 | this function and passes a wl_network_t structure and the | ||
47 | received buffer. The function will strip the data from | ||
48 | the buffer and set it to the structure. | ||
49 | |||
50 | -- | ||
51 | Log to syslog/info: | ||
52 | void wl_loginfo(const char *, ...); | ||
53 | |||
54 | Log to syslog/err: | ||
55 | void wl_logerr(const char *, ...); | ||
56 | |||
57 | Use like printf() function with format strings and so on. | ||
58 | |||
59 | -- | ||
60 | Setup udp socket for incoming commands: | ||
61 | int commsock(const char *, int); | ||
62 | |||
63 | Fist argument is the host where it should listen and second | ||
64 | is the port. Socket is returned, on failure -1 is returned. | ||
65 | |||
66 | |||
67 | Recvfrom socket: | ||
68 | int recv_commsock(int *, char *, int); | ||
69 | |||
70 | First argument is the address of the socket, second is a buffer | ||
71 | that should be filled in and the third is the maxlength of the | ||
72 | buffer. On error, -1 is returned, on success the number of | ||
73 | packet type is returned. (return value should be used with switch | ||
74 | command, for types see proto.hh) | ||
75 | |||
76 | Send command to udp socket: | ||
77 | int sendcomm(const char *, int, const char *, ...); | ||
78 | |||
79 | First two arguments are the host and port where the command should | ||
80 | be send to, followed by buffer that should be send. On error, -1 | ||
81 | is returned. | ||
82 | |||
83 | |||
84 | --- | ||
85 | |||
86 | Thats it for the moment. | ||
87 | |||
88 | mjm. | ||