Zabbix

/*

** Zabbix

** Copyright (C) 2001-2023 Zabbix SIA

**

** 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

** the Free Software Foundation; either version 2 of the License, or

** (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

** GNU General Public License for more details.

**

** You should have received a copy of the GNU General Public License

** along with this program; if not, write to the Free Software

** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

**/

​

#ifndef ZABBIX_MODULE_H

#define ZABBIX_MODULE_H

​

#include "zbxtypes.h"

​

#define ZBX_MODULE_OK   0

#define ZBX_MODULE_FAIL -1

​

/* zbx_module_api_version() MUST return this constant */

#define ZBX_MODULE_API_VERSION  2

​

/* old name alias is kept for source compatibility only, SHOULD NOT be used */

#define ZBX_MODULE_API_VERSION_ONE  ZBX_MODULE_API_VERSION

​

/* HINT: For conditional compilation with different module.h versions modules can use: */

/* #if ZBX_MODULE_API_VERSION == X                                                     */

/*         ...                                                                         */

/* #endif                                                                              */

​

#define get_rkey(request)       (request)->key

#define get_rparams_num(request)    (request)->nparam

#define get_rparam(request, num)    ((request)->nparam > num ? (request)->params[num] : NULL)

#define get_rparam_type(request, num)   ((request)->nparam > num ? (request)->types[num] : \

        REQUEST_PARAMETER_TYPE_UNDEFINED)

​

/* flags for command */

#define CF_HAVEPARAMS       0x01    /* item accepts either optional or mandatory parameters */

#define CF_MODULE       0x02    /* item is defined in a loadable module */

#define CF_USERPARAMETER    0x04    /* item is defined as user parameter */

​

typedef enum

{

    REQUEST_PARAMETER_TYPE_UNDEFINED = 0,

    REQUEST_PARAMETER_TYPE_STRING,

    REQUEST_PARAMETER_TYPE_ARRAY

}

zbx_request_parameter_type_t;

​

/* agent request structure */

typedef struct

{

    char                *key;

    int             nparam;

    char                **params;