c013a50f38d610a9e07d36dfc5529cfc1e5fda7c
[liboping.git] / src / oping.h
1 /**
2  * Object oriented C module to send ICMP and ICMPv6 `echo's.
3  * Copyright (C) 2006  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 #if HAVE_STDLIB_H
28 # include <stdlib.h>
29 #endif
30 #if HAVE_UNISTD_H
31 # include <unistd.h>
32 #endif
33 #if HAVE_SYS_TYPES_H
34 # include <sys/types.h>
35 #endif
36 #if HAVE_SYS_SOCKET_H
37 # include <sys/socket.h>
38 #endif
39
40 /*
41  * Type definitions
42  */
43 struct pinghost;
44 typedef struct pinghost pinghost_t;
45
46 typedef pinghost_t pingobj_iter_t;
47
48 struct pingobj;
49 typedef struct pingobj pingobj_t;
50
51 #define PING_OPT_TIMEOUT 0x01
52 #define PING_OPT_TTL     0x02
53 #define PING_OPT_AF      0x04
54 #define PING_OPT_DATA    0x08
55 #define PING_OPT_SOURCE  0x10
56
57 #define PING_DEF_TIMEOUT 1.0
58 #define PING_DEF_TTL     255
59 #define PING_DEF_AF      AF_UNSPEC
60 #define PING_DEF_DATA    "Florian Forster <octo@verplant.org> http://verplant.org/"
61
62 /*
63  * Method definitions
64  */
65 pingobj_t *ping_construct (void);
66 void ping_destroy (pingobj_t *obj);
67
68 int ping_setopt (pingobj_t *obj, int option, void *value);
69
70 int ping_send (pingobj_t *obj);
71
72 int ping_host_add (pingobj_t *obj, const char *host);
73 int ping_host_remove (pingobj_t *obj, const char *host);
74
75 pingobj_iter_t *ping_iterator_get (pingobj_t *obj);
76 pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter);
77
78 #define PING_INFO_HOSTNAME 1
79 #define PING_INFO_ADDRESS  2
80 #define PING_INFO_FAMILY   3
81 #define PING_INFO_LATENCY  4
82 #define PING_INFO_SEQUENCE 5
83 #define PING_INFO_IDENT    6
84 #define PING_INFO_DATA     7
85 int ping_iterator_get_info (pingobj_iter_t *iter, int info,
86                 void *buffer, size_t *buffer_len);
87
88 const char *ping_get_error (pingobj_t *obj);
89
90 void *ping_iterator_get_context (pingobj_iter_t *iter);
91 void  ping_iterator_set_context (pingobj_iter_t *iter, void *context);
92
93 #endif /* OCTO_PING_H */