Added first high-level interface for the registration table.
authorFlorian Forster <octo@leeloo.lan.home.verplant.org>
Thu, 26 Nov 2009 10:56:09 +0000 (11:56 +0100)
committerFlorian Forster <octo@leeloo.lan.home.verplant.org>
Thu, 26 Nov 2009 10:56:09 +0000 (11:56 +0100)
src/Makefile.am
src/registration_table.c [new file with mode: 0644]
src/routeros_api.h

index da3dda1..8b62c7f 100644 (file)
@@ -15,4 +15,4 @@ librouteros_la_LIBADD = -lgcrypt
 if BUILD_WITH_LIBSOCKET
 librouteros_la_LIBADD += -lsocket
 endif
-librouteros_la_SOURCES = main.c routeros_api.h routeros_version.h
+librouteros_la_SOURCES = main.c registration_table.c routeros_api.h routeros_version.h
diff --git a/src/registration_table.c b/src/registration_table.c
new file mode 100644 (file)
index 0000000..f016a85
--- /dev/null
@@ -0,0 +1,240 @@
+/**
+ * librouteros - src/registration_table.c
+ * Copyright (C) 2009  Florian octo Forster
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; only version 2 of the License is applicable.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ *
+ * Authors:
+ *   Florian octo Forster <octo at verplant.org>
+ **/
+
+#ifndef _ISOC99_SOURCE
+# define _ISOC99_SOURCE
+#endif
+
+#ifndef _POSIX_C_SOURCE
+# define _POSIX_C_SOURCE 200112L
+#endif
+
+#include "config.h"
+
+#include <stdlib.h>
+#include <math.h>
+#include <errno.h>
+#include <string.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include <assert.h>
+
+#include "routeros_api.h"
+
+/*
+Status: re
+  Param 0: .id = *C
+  Param 1: interface = wlan2
+  Param 2: radio-name = 000C423AECCF
+  Param 3: mac-address = 00:0C:42:3A:EC:CF
+  Param 4: ap = true
+  Param 5: wds = false
+  Param 6: rx-rate = 58.5Mbps-HT
+  Param 7: tx-rate = 52.0Mbps-HT
+  Param 8: packets = 6962070,10208268
+  Param 9: bytes = 1090924066,2872515632
+  Param 10: frames = 6662813,9698341
+  Param 11: frame-bytes = 1111022872,2846535122
+  Param 12: hw-frames = 8338229,9718084
+  Param 13: hw-frame-bytes = 1941643579,3255546365
+  Param 14: tx-frames-timed-out = 0
+  Param 15: uptime = 2w6d13:21:53
+  Param 16: last-activity = 00:00:00.060
+  Param 17: signal-strength = -74dBm@6Mbps
+  Param 18: signal-to-noise = 42
+  Param 19: strength-at-rates = -74dBm@6Mbps 10ms,-78dBm@9Mbps 2w2d16h56m20s890ms,-78dBm@12Mbps 2w2d16h55m51s670ms,-77dBm@18Mbps 2w2d16h55m35s880ms,-78dBm@24Mbps 2w2d16h55m5s590ms,-75dBm@36Mbps 1d10h58m48s840ms,-75dBm@48Mbps 1d10h48m34s130ms,-77dBm@54Mbps 1d10h47m34s680ms,-73dBm@HT20-4 38m45s600ms,-73dBm@HT20-5 4m700ms,-74dBm@HT20-6 60ms,-78dBm@HT20-7 1d10h30m34s410ms
+  Param 20: tx-signal-strength = -76
+  Param 21: tx-ccq = 51
+  Param 22: rx-ccq = 77
+  Param 23: p-throughput = 36877
+  Param 24: ack-timeout = 30
+  Param 25: nstreme = false
+  Param 26: framing-mode = none
+  Param 27: routeros-version = 4.2
+  Param 28: last-ip = 62.128.1.53
+  Param 29: 802.1x-port-enabled = true
+  Param 30: authentication-type = wpa2-psk
+  Param 31: encryption = aes-ccm
+  Param 32: group-encryption = aes-ccm
+  Param 33: compression = false
+  Param 34: wmm-enabled = true
+===
+Status: done
+===
+ */
+
+/*
+ * Private data types
+ */
+struct rt_internal_data_s
+{
+       ros_registration_table_handler handler;
+       void *user_data;
+};
+typedef struct rt_internal_data_s rt_internal_data_t;
+
+/*
+ * Private functions
+ */
+static double sstrtod (const char *str) /* {{{ */
+{
+       double ret;
+       char *endptr;
+
+       if (str == NULL)
+               return (NAN);
+
+       errno = 0;
+       endptr = NULL;
+       ret = strtod (str, &endptr);
+       if ((endptr == str) || (errno != 0))
+               return (NAN);
+
+       return (ret);
+} /* }}} double sstrtod */
+
+static int string_to_rx_tx_counters (const char *str, /* {{{ */
+               uint64_t *rx, uint64_t *tx)
+{
+       const char *ptr;
+       char *endptr;
+
+       if ((str == NULL) || (rx == NULL) || (tx == NULL))
+               return (EINVAL);
+
+       ptr = str;
+       errno = 0;
+       endptr = NULL;
+       *rx = (uint64_t) strtoull (ptr, &endptr, /* base = */ 10);
+       if ((endptr == str) || (errno != 0))
+               return (EIO);
+
+       assert (endptr != NULL);
+       if (*endptr != ',')
+               return (EIO);
+
+       ptr = endptr + 1;
+       errno = 0;
+       endptr = NULL;
+       *tx = (uint64_t) strtoull (ptr, &endptr, /* base = */ 10);
+       if ((endptr == str) || (errno != 0))
+               return (EIO);
+
+       return (0);
+} /* }}} int string_to_rx_tx_counters */
+
+static ros_registration_table_t *rt_reply_to_regtable (const ros_reply_t *r) /* {{{ */
+{
+       ros_registration_table_t *ret;
+
+       if (r == NULL)
+               return (NULL);
+
+       if (strcmp ("re", ros_reply_status (r)) != 0)
+               return (rt_reply_to_regtable (ros_reply_next (r)));
+
+       ret = malloc (sizeof (*ret));
+       if (ret == NULL)
+               return (NULL);
+       memset (ret, 0, sizeof (*ret));
+
+       ret->interface = ros_reply_param_val_by_key (r, "interface");
+
+       ret->rx_rate = sstrtod (ros_reply_param_val_by_key (r, "rx-rate"));
+       ret->tx_rate = sstrtod (ros_reply_param_val_by_key (r, "tx-rate"));
+
+       string_to_rx_tx_counters (ros_reply_param_val_by_key (r, "packets"),
+                       &ret->rx_packets, &ret->tx_packets);
+       string_to_rx_tx_counters (ros_reply_param_val_by_key (r, "bytes"),
+                       &ret->rx_bytes, &ret->tx_bytes);
+       string_to_rx_tx_counters (ros_reply_param_val_by_key (r, "frames"),
+                       &ret->rx_frames, &ret->tx_frames);
+       string_to_rx_tx_counters (ros_reply_param_val_by_key (r, "frame-bytes"),
+                       &ret->rx_frame_bytes, &ret->tx_frame_bytes);
+       string_to_rx_tx_counters (ros_reply_param_val_by_key (r, "hw-frames"),
+                       &ret->rx_hw_frames, &ret->tx_hw_frames);
+       string_to_rx_tx_counters (ros_reply_param_val_by_key (r, "hw-frame-bytes"),
+                       &ret->rx_hw_frame_bytes, &ret->tx_hw_frame_bytes);
+
+       ret->rx_signal_strength = sstrtod (ros_reply_param_val_by_key (r, "signal-strength"));
+       ret->tx_signal_strength = sstrtod (ros_reply_param_val_by_key (r, "tx-signal-strength"));
+       ret->signal_to_noise = sstrtod (ros_reply_param_val_by_key (r, "signal-to-noise"));
+
+       ret->rx_ccq = sstrtod (ros_reply_param_val_by_key (r, "rx-ccq"));
+       ret->tx_ccq = sstrtod (ros_reply_param_val_by_key (r, "tx-ccq"));
+
+       ret->next = rt_reply_to_regtable (ros_reply_next (r));
+
+       return (ret);
+} /* }}} ros_registration_table_t *rt_reply_to_regtable */
+
+static void rt_regtable_free (ros_registration_table_t *r) /* {{{ */
+{
+       ros_registration_table_t *next;
+
+       while (r != NULL)
+       {
+               next = r->next;
+               free (r);
+               r = next;
+       }
+} /* }}} void rt_regtable_free */
+
+static int rt_internal_handler (ros_connection_t *c, /* {{{ */
+               const ros_reply_t *r, void *user_data)
+{
+       ros_registration_table_t *rt_data;
+       rt_internal_data_t *internal_data;
+       int status;
+
+       rt_data = rt_reply_to_regtable (r);
+       if (rt_data == NULL)
+               return (errno);
+
+       internal_data = user_data;
+
+       status = internal_data->handler (c, rt_data, internal_data->user_data);
+
+       rt_regtable_free (rt_data);
+
+       return (status);
+} /* }}} int rt_internal_handler */
+
+/*
+ * Public functions
+ */
+int ros_registration_table (ros_connection_t *c, /* {{{ */
+               ros_registration_table_handler handler, void *user_data)
+{
+       rt_internal_data_t data;
+
+       if ((c == NULL) || (handler == NULL))
+               return (EINVAL);
+
+       data.handler = handler;
+       data.user_data = user_data;
+
+       return (ros_query (c, "/interface/wireless/registration-table/print",
+                               /* args_num = */ 0, /* args = */ NULL,
+                               rt_internal_handler, &data));
+} /* }}} int ros_registration_table */
+
+/* vim: set ts=2 sw=2 noet fdm=marker : */
index 55309e6..f1395c9 100644 (file)
@@ -69,6 +69,54 @@ const char *ros_reply_param_val_by_index (const ros_reply_t *r,
                unsigned int index);
 const char *ros_reply_param_val_by_key (const ros_reply_t *r, const char *key);
 
+/*
+ * High-level function for accessing /interface/wireless/registration-table
+ */
+struct ros_registration_table_s;
+typedef struct ros_registration_table_s ros_registration_table_t;
+struct ros_registration_table_s
+{
+       /* Name of the interface */
+       const char *interface;
+
+       /* Receive and transmit rate in MBit/s */
+       double rx_rate;
+       double tx_rate;
+
+       /* Packet, octet and frame counters. */
+       uint64_t rx_packets;
+       uint64_t tx_packets;
+       uint64_t rx_bytes;
+       uint64_t tx_bytes;
+       uint64_t rx_frames;
+       uint64_t tx_frames;
+       uint64_t rx_frame_bytes;
+       uint64_t tx_frame_bytes;
+       uint64_t rx_hw_frames;
+       uint64_t tx_hw_frames;
+       uint64_t rx_hw_frame_bytes;
+       uint64_t tx_hw_frame_bytes;
+
+       /* Signal quality information (in dBm) */
+       double rx_signal_strength;
+       double tx_signal_strength;
+       double signal_to_noise;
+
+       /* Overall connection quality (in percent) */
+       double rx_ccq;
+       double tx_ccq;
+
+       /* Next interface */
+       ros_registration_table_t *next;
+};
+
+/* Callback function */
+typedef int (*ros_registration_table_handler) (ros_connection_t *c,
+               const ros_registration_table_t *r, void *user_data);
+
+int ros_registration_table (ros_connection_t *c,
+               ros_registration_table_handler handler, void *user_data);
+
 #ifdef __cplusplus
 }
 #endif