src/oping.h

   1 /**
   2  * Object oriented C module to send ICMP and ICMPv6 `echo's.
   3  * Copyright (C) 2006-2009  Florian octo Forster <octo at verplant.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; only version 2 of the License is
   8  * applicable.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  */
  19
  20 #ifndef OCTO_PING_H
  21 #define OCTO_PING_H 1
  22
  23 #if HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #include <sys/types.h>
  30 #include <sys/socket.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #define OPING_VERSION 1003002
  37
  38 /*
  39  * Type definitions
  40  */
  41 struct pinghost;
  42 typedef struct pinghost pinghost_t;
  43
  44 typedef pinghost_t pingobj_iter_t;
  45
  46 struct pingobj;
  47 typedef struct pingobj pingobj_t;
  48
  49 #define PING_OPT_TIMEOUT 0x01
  50 #define PING_OPT_TTL     0x02
  51 #define PING_OPT_AF      0x04
  52 #define PING_OPT_DATA    0x08
  53 #define PING_OPT_SOURCE  0x10
  54 #define PING_OPT_DEVICE  0x20
  55
  56 #define PING_DEF_TIMEOUT 1.0
  57 #define PING_DEF_TTL     255
  58 #define PING_DEF_AF      AF_UNSPEC
  59 #define PING_DEF_DATA    "Florian Forster <octo@verplant.org> http://verplant.org/"
  60
  61 /*
  62  * Method definitions
  63  */
  64 pingobj_t *ping_construct (void);
  65 void ping_destroy (pingobj_t *obj);
  66
  67 int ping_setopt (pingobj_t *obj, int option, void *value);
  68
  69 int ping_send (pingobj_t *obj);
  70
  71 int ping_host_add (pingobj_t *obj, const char *host);
  72 int ping_host_remove (pingobj_t *obj, const char *host);
  73
  74 pingobj_iter_t *ping_iterator_get (pingobj_t *obj);
  75 pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter);
  76
  77 #define PING_INFO_HOSTNAME  1
  78 #define PING_INFO_ADDRESS   2
  79 #define PING_INFO_FAMILY    3
  80 #define PING_INFO_LATENCY   4
  81 #define PING_INFO_SEQUENCE  5
  82 #define PING_INFO_IDENT     6
  83 #define PING_INFO_DATA      7
  84 #define PING_INFO_USERNAME  8
  85 #define PING_INFO_DROPPED   9
  86 #define PING_INFO_RECV_TTL 10
  87 int ping_iterator_get_info (pingobj_iter_t *iter, int info,
  88                 void *buffer, size_t *buffer_len);
  89
  90 const char *ping_get_error (pingobj_t *obj);
  91
  92 void *ping_iterator_get_context (pingobj_iter_t *iter);
  93 void  ping_iterator_set_context (pingobj_iter_t *iter, void *context);
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif /* OCTO_PING_H */