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 #define ROUTEROS_API_PORT "8728"
  23
  24 struct mt_connection_s;
  25 typedef struct mt_connection_s mt_connection_t;
  26
  27 struct mt_reply_s;
  28 typedef struct mt_reply_s mt_reply_t;
  29
  30 typedef int (*mt_reply_handler_t) (mt_connection_t *c, const mt_reply_t *r,
  31                 void *user_data);
  32
  33 /*
  34  * Connection handling
  35  */
  36 mt_connection_t *mt_connect (const char *node, const char *service,
  37                 const char *username, const char *password);
  38 int mt_disconnect (mt_connection_t *con);
  39
  40 /*
  41  * Command execution
  42  */
  43 int mt_query (mt_connection_t *c,
  44                 const char *command,
  45                 size_t args_num, const char * const *args,
  46                 mt_reply_handler_t handler, void *user_data);
  47
  48 /*
  49  * Reply handling
  50  */
  51 const mt_reply_t *mt_reply_next (const mt_reply_t *r);
  52 int mt_reply_num (const mt_reply_t *r);
  53
  54 const char *mt_reply_status (const mt_reply_t *r);
  55
  56 /* Receiving reply parameters */
  57 const char *mt_reply_param_key_by_index (const mt_reply_t *r,
  58                 unsigned int index);
  59 const char *mt_reply_param_val_by_index (const mt_reply_t *r,
  60                 unsigned int index);
  61 const char *mt_reply_param_val_by_key (const mt_reply_t *r, const char *key);
  62
  63 /* vim: set ts=2 sw=2 noet fdm=marker : */