X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Frouteros_api.h;h=b556bcb10f1675c8618ff262192c50851fd76ed6;hb=7046644fa5f9aac043ac53e3ab9f7f7c56c45b05;hp=7995c283527b6f3a40dfc07611986b71ec7e80c6;hpb=e0846ddeb8558dced2e49d501b971d98ce2f9f66;p=routeros-api.git diff --git a/src/routeros_api.h b/src/routeros_api.h index 7995c28..b556bcb 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,215 @@ * Florian octo Forster **/ +#ifndef ROUTEROS_API_H +#define ROUTEROS_API_H 1 + +#include +#include + +#include + #define ROUTEROS_API_PORT "8728" -struct mt_connection_s; -typedef struct mt_connection_s mt_connection_t; +/* + * C++ doesn't have _Bool. We can't simply "#define _Bool bool", because we + * don't know if "bool" and "_Bool" are of the same size. If they are not, this + * would result in ABI incompatible code. + * + * So we're doing a best-effort solution here: If we're compiled with the GNU + * C++ compiler, g++, we include . The GCC will, as a GNU extension, + * define _Bool for C++. Since it's the compiler doing the definition, it's + * kind of save to assume that it will be done in an ABI compatible manner. + * + * If this results in any problems for you, define "ROS_HAVE_CPP_BOOL" to true + * to have this magic disabled. You will then have to define _Bool yourself. + * + * TODO: Write a test program for the configure sript to figure out the size of + * _Bool. Make this size available via and define _Bool + * to short, long, ... here. + */ +#ifdef __cplusplus +# if !defined (ROS_HAVE_CPP_BOOL) || !ROS_HAVE_CPP_BOOL +# ifdef __GNUC__ +# include +# endif /* __GNUC__ */ +# endif /* !defined (ROS_HAVE_CPP_BOOL) || !ROS_HAVE_CPP_BOOL */ + +extern "C" { +#endif + +struct ros_connection_s; +typedef struct ros_connection_s ros_connection_t; -struct mt_reply_s; -typedef struct mt_reply_s mt_reply_t; +struct ros_reply_s; +typedef struct ros_reply_s ros_reply_t; -typedef int (*mt_reply_handler_t) (mt_connection_t *c, const mt_reply_t *r, +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 */ + +/* High-level function for accessing /system/resource {{{ */ +struct ros_system_resource_s; +typedef struct ros_system_resource_s ros_system_resource_t; +struct ros_system_resource_s +{ + uint64_t uptime; + + const char *version; + const char *architecture_name; + const char *board_name; + + const char *cpu_model; + unsigned int cpu_count; + unsigned int cpu_load; + uint64_t cpu_frequency; + + uint64_t free_memory; + uint64_t total_memory; + + uint64_t free_hdd_space; + uint64_t total_hdd_space; + + uint64_t write_sect_since_reboot; + uint64_t write_sect_total; + uint64_t bad_blocks; +}; + +/* Callback function */ +typedef int (*ros_system_resource_handler_t) (ros_connection_t *c, + const ros_system_resource_t *r, void *user_data); + +int ros_system_resource (ros_connection_t *c, + ros_system_resource_handler_t handler, void *user_data); +/* }}} /system/resource */ + +#ifdef __cplusplus +} +#endif + +#endif /* ROUTEROS_API_H */ /* vim: set ts=2 sw=2 noet fdm=marker : */