src/openvpn/status.h

   1 /*
   2  *  OpenVPN -- An application to securely tunnel IP networks
   3  *             over a single TCP/UDP port, with support for SSL/TLS-based
   4  *             session authentication and key exchange,
   5  *             packet encryption, packet authentication, and
   6  *             packet compression.
   7  *
   8  *  Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net>
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License version 2
  12  *  as published by the Free Software Foundation.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program (see the file COPYING included with this
  21  *  distribution); if not, write to the Free Software Foundation, Inc.,
  22  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #ifndef STATUS_H
  26 #define STATUS_H
  27
  28 #include "interval.h"
  29
  30 /*
  31  * virtual function interface for status output
  32  */
  33 struct virtual_output {
  34   void *arg;
  35   unsigned int flags_default;
  36   void (*func) (void *arg, const unsigned int flags, const char *str);
  37 };
  38
  39 static inline void
  40 virtual_output_print (const struct virtual_output *vo, const unsigned int flags, const char *str)
  41 {
  42   (*vo->func) (vo->arg, flags, str);
  43 }
  44
  45 /*
  46  * printf-style interface for inputting/outputting status info
  47  */
  48
  49 struct status_output
  50 {
  51 # define STATUS_OUTPUT_READ  (1<<0)
  52 # define STATUS_OUTPUT_WRITE (1<<1)
  53   unsigned int flags;
  54
  55   char *filename;
  56   int fd;
  57   int msglevel;
  58   const struct virtual_output *vout;
  59
  60   struct buffer read_buf;
  61
  62   struct event_timeout et;
  63
  64   bool errors;
  65 };
  66
  67 struct status_output *status_open (const char *filename,
  68                                    const int refresh_freq,
  69                                    const int msglevel,
  70                                    const struct virtual_output *vout,
  71                                    const unsigned int flags);
  72
  73 bool status_trigger_tv (struct status_output *so, struct timeval *tv);
  74 bool status_trigger (struct status_output *so);
  75 void status_reset (struct status_output *so);
  76 void status_flush (struct status_output *so);
  77 bool status_close (struct status_output *so);
  78 void status_printf (struct status_output *so, const char *format, ...)
  79 #ifdef __GNUC__
  80     __attribute__ ((format (printf, 2, 3)))
  81 #endif
  82     ;
  83
  84 bool status_read (struct status_output *so, struct buffer *buf);
  85
  86 static inline unsigned int
  87 status_rw_flags (const struct status_output *so)
  88 {
  89   if (so)
  90     return so->flags;
  91   else
  92     return 0;
  93 }
  94
  95 #endif