documentation: Parameter defaults and documentation

- Updated documentation files to describe parameters
- "Self-documenting" parameters added to code
- Parameter defaults revised
- Sample configuration file of defaults added

[cleanup commit message]
Signed-off-by: Nick Hainke <vincent@systemli.org>
This commit is contained in:
Ian Clowes 2022-02-17 16:36:07 +00:00 committed by Nick Hainke
parent ba305bb2c2
commit c54cd95abe
10 changed files with 725 additions and 244 deletions

View file

@ -101,18 +101,18 @@ struct probe_metric_s {
};
struct time_config_s {
time_t update_client;
time_t remove_client;
time_t remove_probe;
time_t remove_ap;
time_t update_hostapd;
time_t update_tcp_con;
time_t update_chan_util;
time_t update_beacon_reports;
time_t update_client; // Query locally connected clients
time_t remove_client; // Delete aged client records
time_t remove_probe; // Delete aged PROBE / BEACON records
time_t remove_ap; // Delete aged AP records
time_t update_hostapd; // Refresh wifi radio / SSID data from hostapd
time_t update_tcp_con; // Refresh network connections
time_t update_chan_util; // Refresh per radio / SSID channel util info
time_t update_beacon_reports; // Request BEACON from capable clients
};
struct local_config_s {
int loglevel;
int loglevel; // Select the level of messgae in syslog
};
// FIXME: Are these with or without NUL terminator? Adjust values, string allocation and strncpy() to agree.
@ -124,7 +124,7 @@ struct network_config_s {
int broadcast_port;
char server_ip[MAX_IP_LENGTH + 1];
int tcp_port;
int network_option;
int network_option; // 0:Broadcast; 1:Multicast; 2:TCP+UMDNS; 3:TCP
char shared_key[MAX_KEY_LENGTH + 1];
char iv[MAX_KEY_LENGTH + 1];
int use_symm_enc;