src/routeros_api.h

   1 /**
   2  * libmikrotik - src/mikrotik.h
   3  * Copyright (C) 2009  Florian octo Forster
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #ifndef ROUTEROS_API_H
  23 #define ROUTEROS_API_H 1
  24
  25 #define ROUTEROS_API_PORT "8728"
  26
  27 struct ros_connection_s;
  28 typedef struct ros_connection_s ros_connection_t;
  29
  30 struct ros_reply_s;
  31 typedef struct ros_reply_s ros_reply_t;
  32
  33 typedef int (*ros_reply_handler_t) (ros_connection_t *c, const ros_reply_t *r,
  34                 void *user_data);
  35
  36 /*
  37  * Connection handling
  38  */
  39 ros_connection_t *ros_connect (const char *node, const char *service,
  40                 const char *username, const char *password);
  41 int ros_disconnect (ros_connection_t *con);
  42
  43 /*
  44  * Command execution
  45  */
  46 int ros_query (ros_connection_t *c,
  47                 const char *command,
  48                 size_t args_num, const char * const *args,
  49                 ros_reply_handler_t handler, void *user_data);
  50
  51 /*
  52  * Reply handling
  53  */
  54 const ros_reply_t *ros_reply_next (const ros_reply_t *r);
  55 int ros_reply_num (const ros_reply_t *r);
  56
  57 const char *ros_reply_status (const ros_reply_t *r);
  58
  59 /* Receiving reply parameters */
  60 const char *ros_reply_param_key_by_index (const ros_reply_t *r,
  61                 unsigned int index);
  62 const char *ros_reply_param_val_by_index (const ros_reply_t *r,
  63                 unsigned int index);
  64 const char *ros_reply_param_val_by_key (const ros_reply_t *r, const char *key);
  65
  66 #endif /* ROUTEROS_API_H */
  67
  68 /* vim: set ts=2 sw=2 noet fdm=marker : */