Improve docstring of the history_received field.

[liboping.git] / src / oping.c

diff --git a/src/oping.c b/src/oping.c
index 53602d3..528c90d 100644 (file)
--- a/src/oping.c
+++ b/src/oping.c
@@ -1,6 +1,6 @@
 /**
  * Object oriented C module to send ICMP and ICMPv6 `echo's.
- * Copyright (C) 2006-2014  Florian octo Forster <ff at octo.it>
+ * Copyright (C) 2006-2016  Florian octo Forster <ff at octo.it>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -82,11 +82,17 @@
 /* http://newsgroups.derkeiler.com/Archive/Rec/rec.games.roguelike.development/2010-09/msg00050.html */
 # define _X_OPEN_SOURCE_EXTENDED
 
-# if HAVE_NCURSESW_NCURSES_H
-#  include <ncursesw/ncurses.h>
-# elif HAVE_NCURSES_H
+#if defined HAVE_NCURSESW_CURSES_H
+#  include <ncursesw/curses.h>
+#elif defined HAVE_NCURSESW_H
+#  include <ncursesw.h>
+#elif defined HAVE_NCURSES_CURSES_H
+#  include <ncurses/curses.h>
+#elif defined HAVE_NCURSES_H
 #  include <ncurses.h>
-# endif
+#else
+#  error "SysV or X/Open-compatible Curses header file required"
+#endif
 
 # define OPING_GREEN 1
 # define OPING_YELLOW 2
@@ -172,7 +178,7 @@ typedef struct ping_context
         * and HISTORY_SIZE_MAX. */
        size_t history_size;
 
-       /* Number "received" entries in the history, i.e. non-NAN entries. */
+       /* Total number of reponses received. */
        size_t history_received;
 
        /* Index of the next RTT to be written to history_by_time. This wraps
@@ -208,8 +214,11 @@ static double  opt_exit_status_threshold = 1.0;
 static int     opt_show_graph = 1;
 static int     opt_utf8       = 0;
 #endif
+static char   *opt_outfile    = NULL;
+static int     opt_bell       = 0;
 
-static int host_num = 0;
+static int host_num  = 0;
+static FILE *outfile = NULL;
 
 #if USE_NCURSES
 static WINDOW *main_win = NULL;
@@ -223,22 +232,17 @@ static void sigint_handler (int signal) /* {{{ */
        opt_count = 0;
 } /* }}} void sigint_handler */
 
-static ping_context_t *context_create (void) /* {{{ */
+static ping_context_t *context_create () /* {{{ */
 {
-       ping_context_t *ret;
-
-       if ((ret = malloc (sizeof (ping_context_t))) == NULL)
+       ping_context_t *ctx = calloc (1, sizeof (*ctx));
+       if (ctx == NULL)
                return (NULL);
 
-       memset (ret, '\0', sizeof (ping_context_t));
-
-       ret->latency_total = 0.0;
-
 #if USE_NCURSES
-       ret->window = NULL;
+       ctx->window = NULL;
 #endif
 
-       return (ret);
+       return (ctx);
 } /* }}} ping_context_t *context_create */
 
 static void context_destroy (ping_context_t *context) /* {{{ */
@@ -439,7 +443,8 @@ static void usage_exit (const char *name, int status) /* {{{ */
                        "  -I srcaddr   source address\n"
                        "  -D device    outgoing interface name\n"
                        "  -m mark      mark to set on outgoing packets\n"
-                       "  -f filename  filename to read hosts from\n"
+                       "  -f filename  read hosts from <filename>\n"
+                       "  -O filename  write RTT measurements to <filename>\n"
 #if USE_NCURSES
                        "  -u / -U      force / disable UTF-8 output\n"
                        "  -g graph     graph type to draw\n"
@@ -649,7 +654,7 @@ static int read_options (int argc, char **argv) /* {{{ */
 
        while (1)
        {
-               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:P:m:w:"
+               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:O:P:m:w:b"
 #if USE_NCURSES
                                "uUg:"
 #endif
@@ -746,6 +751,13 @@ static int read_options (int argc, char **argv) /* {{{ */
                                set_opt_send_qos (optarg);
                                break;
 
+                       case 'O':
+                               {
+                                       free (opt_outfile);
+                                       opt_outfile = strdup (optarg);
+                               }
+                               break;
+
                        case 'P':
                                {
                                        double new_percentile;
@@ -781,6 +793,9 @@ static int read_options (int argc, char **argv) /* {{{ */
                                opt_utf8 = 1;
                                break;
 #endif
+                       case 'b':
+                               opt_bell = 1;
+                               break;
 
                        case 'Z':
                        {
@@ -1346,10 +1361,11 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */
        if (has_colors () == TRUE)
        {
                start_color ();
-               init_pair (OPING_GREEN,  COLOR_GREEN,  /* default = */ 0);
-               init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ 0);
-               init_pair (OPING_RED,    COLOR_RED,    /* default = */ 0);
-               init_pair (OPING_GREEN_HIST,  COLOR_GREEN,  COLOR_BLACK);
+               use_default_colors ();
+               init_pair (OPING_GREEN,  COLOR_GREEN,  /* default = */ -1);
+               init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ -1);
+               init_pair (OPING_RED,    COLOR_RED,    /* default = */ -1);
+               init_pair (OPING_GREEN_HIST,  COLOR_GREEN,  -1);
                init_pair (OPING_YELLOW_HIST, COLOR_YELLOW, COLOR_GREEN);
                init_pair (OPING_RED_HIST,    COLOR_RED,    COLOR_YELLOW);
        }
@@ -1566,6 +1582,13 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
 #if USE_NCURSES
                }
 #endif
+                if (opt_bell) {
+#if USE_NCURSES
+                       beep();
+#else
+                       HOST_PRINTF ("\a");
+#endif
+                }
        }
        else /* if (!(latency > 0.0)) */
        {
@@ -1591,6 +1614,20 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
 #endif
        }
 
+       if (outfile != NULL)
+       {
+               struct timeval tv = {0};
+               if (gettimeofday (&tv, NULL) == 0)
+               {
+                       double t = ((double) tv.tv_sec) + (((double) tv.tv_usec) / 1000000.0);
+
+                       if ((sequence % 32) == 0)
+                               fprintf (outfile, "#time,host,latency[ms]\n");
+
+                       fprintf (outfile, "%.3f,\"%s\",%.2f\n", t, context->host, latency);
+               }
+       }
+
 #if USE_NCURSES
        update_stats_from_context (context, iter);
        wrefresh (main_win);
@@ -1890,6 +1927,17 @@ int main (int argc, char **argv) /* {{{ */
        saved_set_uid = (uid_t) -1;
 #endif
 
+       if (opt_outfile != NULL)
+       {
+               outfile = fopen (opt_outfile, "a");
+               if (outfile == NULL)
+               {
+                       fprintf (stderr, "opening \"%s\" failed: %s\n",
+                                opt_outfile, strerror (errno));
+                       exit (EXIT_FAILURE);
+               }
+       }
+
        ping_initialize_contexts (ping);
 
        if (i == 0)
@@ -1976,6 +2024,12 @@ int main (int argc, char **argv) /* {{{ */
 
        ping_destroy (ping);
 
+       if (outfile != NULL)
+       {
+               fclose (outfile);
+               outfile = NULL;
+       }
+
        if (status == 0)
                exit (EXIT_SUCCESS);
        else