2 * librouteros - src/routeros_api.h
3 * Copyright (C) 2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
22 #ifndef ROUTEROS_API_H
23 #define ROUTEROS_API_H 1
25 #include <routeros_version.h>
27 #define ROUTEROS_API_PORT "8728"
33 struct ros_connection_s;
34 typedef struct ros_connection_s ros_connection_t;
37 typedef struct ros_reply_s ros_reply_t;
39 typedef int (*ros_reply_handler_t) (ros_connection_t *c, const ros_reply_t *r,
45 ros_connection_t *ros_connect (const char *node, const char *service,
46 const char *username, const char *password);
47 int ros_disconnect (ros_connection_t *con);
52 int ros_query (ros_connection_t *c,
54 size_t args_num, const char * const *args,
55 ros_reply_handler_t handler, void *user_data);
60 const ros_reply_t *ros_reply_next (const ros_reply_t *r);
61 int ros_reply_num (const ros_reply_t *r);
63 const char *ros_reply_status (const ros_reply_t *r);
65 /* Receiving reply parameters */
66 const char *ros_reply_param_key_by_index (const ros_reply_t *r,
68 const char *ros_reply_param_val_by_index (const ros_reply_t *r,
70 const char *ros_reply_param_val_by_key (const ros_reply_t *r, const char *key);
73 * High-level function for accessing /interface/wireless/registration-table
75 struct ros_registration_table_s;
76 typedef struct ros_registration_table_s ros_registration_table_t;
77 struct ros_registration_table_s
79 /* Name of the interface */
80 const char *interface;
82 /* Receive and transmit rate in MBit/s */
86 /* Packet, octet and frame counters. */
93 uint64_t rx_frame_bytes;
94 uint64_t tx_frame_bytes;
95 uint64_t rx_hw_frames;
96 uint64_t tx_hw_frames;
97 uint64_t rx_hw_frame_bytes;
98 uint64_t tx_hw_frame_bytes;
100 /* Signal quality information (in dBm) */
101 double rx_signal_strength;
102 double tx_signal_strength;
103 double signal_to_noise;
105 /* Overall connection quality (in percent) */
110 ros_registration_table_t *next;
113 /* Callback function */
114 typedef int (*ros_registration_table_handler) (ros_connection_t *c,
115 const ros_registration_table_t *r, void *user_data);
117 int ros_registration_table (ros_connection_t *c,
118 ros_registration_table_handler handler, void *user_data);
124 #endif /* ROUTEROS_API_H */
126 /* vim: set ts=2 sw=2 noet fdm=marker : */