X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Frouteros_api.h;h=aac39dbf6f4d54ae6d12b21dbbf47b2d495a6f0b;hb=0bf7ecba787380d37947bb1537e2dc3496fd13ee;hp=070b2eab11f2c366236bd51118844b2de41de905;hpb=c51d83a318374124b877a52cd3f85c173d4bb4a5;p=routeros-api.git

diff --git a/src/routeros_api.h b/src/routeros_api.h
index 070b2ea..aac39db 100644
--- a/src/routeros_api.h
+++ b/src/routeros_api.h
@@ -1,5 +1,5 @@
 /**
- * libmikrotik - src/mikrotik.h
+ * librouteros - src/routeros_api.h
  * Copyright (C) 2009  Florian octo Forster
  *
  * This program is free software; you can redistribute it and/or modify it
@@ -19,41 +19,157 @@
  *   Florian octo Forster <octo at verplant.org>
  **/
 
+#ifndef ROUTEROS_API_H
+#define ROUTEROS_API_H 1
+
+#include <stdint.h>
+#include <inttypes.h>
+
+#include <routeros_version.h>
+
 #define ROUTEROS_API_PORT "8728"
 
-struct mt_connection_s;
-typedef struct mt_connection_s mt_connection_t;
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-struct mt_reply_s;
-typedef struct mt_reply_s mt_reply_t;
+struct ros_connection_s;
+typedef struct ros_connection_s ros_connection_t;
 
-typedef int (*mt_reply_handler_t) (mt_connection_t *c, const mt_reply_t *r,
+struct ros_reply_s;
+typedef struct ros_reply_s ros_reply_t;
+
+typedef int (*ros_reply_handler_t) (ros_connection_t *c, const ros_reply_t *r,
 		void *user_data);
 
 /*
  * Connection handling
  */
-mt_connection_t *mt_connect (const char *node, const char *service,
+ros_connection_t *ros_connect (const char *node, const char *service,
 		const char *username, const char *password);
-int mt_disconnect (mt_connection_t *con);
+int ros_disconnect (ros_connection_t *con);
 
 /* 
  * Command execution
  */
-int mt_query (mt_connection_t *c,
+int ros_query (ros_connection_t *c,
 		const char *command,
 		size_t args_num, const char * const *args,
-		mt_reply_handler_t *handler, void *user_data);
+		ros_reply_handler_t handler, void *user_data);
 
 /* 
  * Reply handling
  */
-const mt_reply_t *mt_reply_next (const mt_reply_t *r);
-int mt_reply_num (const mt_reply_t *r);
+const ros_reply_t *ros_reply_next (const ros_reply_t *r);
+int ros_reply_num (const ros_reply_t *r);
+
+const char *ros_reply_status (const ros_reply_t *r);
 
 /* Receiving reply parameters */
-const char *mt_reply_param_key_by_index (const mt_reply_t *r, unsigned int index);
-const char *mt_reply_param_val_by_index (const mt_reply_t *r, unsigned int index);
-const char *mt_reply_param_val_by_key (const mt_reply_t *r, const char *key);
+const char *ros_reply_param_key_by_index (const ros_reply_t *r,
+		unsigned int index);
+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 {{{ */
+struct ros_interface_s;
+typedef struct ros_interface_s ros_interface_t;
+struct ros_interface_s
+{
+	/* Name of the interface */
+	const char *name;
+	const char *type;
+	const char *comment;
+
+	/* Packet, octet and error counters. */
+	uint64_t rx_packets;
+	uint64_t tx_packets;
+	uint64_t rx_bytes;
+	uint64_t tx_bytes;
+	uint64_t rx_errors;
+	uint64_t tx_errors;
+	uint64_t rx_drops;
+	uint64_t tx_drops;
+
+	/* Maximum transfer unit */
+	unsigned int mtu;
+	unsigned int l2mtu;
+
+	/* Interface flags */
+	_Bool dynamic;
+	_Bool running;
+	_Bool enabled;
+
+	/* Next interface */
+	const ros_interface_t *next;
+};
+
+/* Callback function */
+typedef int (*ros_interface_handler_t) (ros_connection_t *c,
+		const ros_interface_t *i, void *user_data);
+
+int ros_interface (ros_connection_t *c,
+		ros_interface_handler_t handler, void *user_data);
+/* }}} /interface */
+
+/* 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;
+	/* Name of the remote radio */
+	const char *radio_name;
+
+	/* ap is set to true, if the REMOTE radio is an access point. */
+	_Bool ap;
+	_Bool wds;
+
+	/* 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 */
+	const ros_registration_table_t *next;
+};
+
+/* Callback function */
+typedef int (*ros_registration_table_handler_t) (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_t handler, void *user_data);
+/* }}} /interface/wireless/registration-table */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ROUTEROS_API_H */
 
 /* vim: set ts=2 sw=2 noet fdm=marker : */