plugins/runcmd.h

   1 /****************************************************************************
   2 *
   3 * License: GPL
   4 * Copyright (c) 2005 Nagios Plugins Development Team
   5 * Author: Andreas Ericsson <ae@op5.se>
   6 *
   7 *
   8 * This program is free software: you can redistribute it and/or modify
   9 * it under the terms of the GNU General Public License as published by
  10 * the Free Software Foundation, either version 3 of the License, or
  11 * (at your option) any later version.
  12 *
  13 * This program is distributed in the hope that it will be useful,
  14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 * GNU General Public License for more details.
  17 *
  18 * You should have received a copy of the GNU General Public License
  19 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 *
  21 * $Id$
  22 *
  23 *****************************************************************************/
  24
  25 #ifndef NAGIOSPLUG_RUNCMD_H
  26 #define NAGIOSPLUG_RUNCMD_H
  27
  28 #include "common.h"
  29
  30 /** types **/
  31 struct output {
  32         char *buf;     /* output buffer */
  33         size_t buflen; /* output buffer content length */
  34         char **line;   /* array of lines (points to buf) */
  35         size_t *lens;  /* string lengths */
  36         size_t lines;  /* lines of output */
  37 };
  38
  39 typedef struct output output;
  40
  41 /** prototypes **/
  42 int np_runcmd(const char *, output *, output *, int);
  43 void popen_timeout_alarm_handler(int)
  44         __attribute__((__noreturn__));
  45
  46 /* only multi-threaded plugins need to bother with this */
  47 void np_runcmd_init(void);
  48 #define NP_RUNCMD_INIT np_runcmd_init()
  49
  50 /* possible flags for np_runcmd()'s fourth argument */
  51 #define RUNCMD_NO_ARRAYS 0x01 /* don't populate arrays at all */
  52 #define RUNCMD_NO_ASSOC 0x02  /* output.line won't point to buf */
  53
  54 #endif /* NAGIOSPLUG_RUNCMD_H */