nsh.h

Go to the documentation of this file.

/* libnsh - Net-SNMP helper C-library
 *
 * Copyright (c) 2016  Jonas Johansson <jonasj76@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef NSH_H_
#define NSH_H_

#include "table.h"
#include "private.h"
#include "deprecated.h"

#define nsh_register_scalar_ro(name) \
    _nsh_register_scalar(name, HANDLER_CAN_RONLY)

#define nsh_register_scalar_rw(name) \
    _nsh_register_scalar(name, HANDLER_CAN_RWRITE)

#define nsh_scalar_handler_const(name, type, value) \
        _nsh_scalar_handler(name, type, 0, NULL, sizeof(long), value, NULL)

#define nsh_scalar_handler_ro(name, type, callback, size) \
    _nsh_scalar_handler(name, type, 0, callback, size, 0, NULL)

#define nsh_scalar_str_handler_ro(name, callback, max_length) \
    _nsh_scalar_handler(name, ASN_OCTET_STR, 0, callback, max_length, 1, NULL)

#define nsh_scalar_group_handler_ro(name, type, id, callback, size, isstring) \
    _nsh_scalar_handler(name, type, id, callback, size, isstring, NULL)

#define nsh_scalar_handler_rw(name, type, nsh_get_cb, size, nsh_set_cb) \
    _nsh_scalar_handler(name, type, 0, nsh_get_cb, size, 0, nsh_set_cb)

#define nsh_scalar_str_handler_rw(name, nsh_get_cb, max_length, nsh_set_cb) \
    _nsh_scalar_handler(name, ASN_OCTET_STR, 0, nsh_get_cb, max_length, 1, nsh_set_cb)

#define nsh_scalar_group_handler_rw(name, type, id, nsh_get_cb, size, isstring, nsh_set_cb) \
    _nsh_scalar_handler(name, type, id, nsh_get_cb, size, isstring, nsh_set_cb)

typedef int (*nsh_get_cb)(void *value, int len, int id);

typedef int (*nsh_set_cb)(void *value, int id);

#define nsh_table(name, get_first_cb, get_next_cb, free_cb, table_data, head, num_table, index_list, num_indexes) \
    nsh_table_get_next(get_next_cb, table_data, index_list, num_indexes) \
    nsh_table_get_first(get_first_cb, get_next_cb, head)        \
    nsh_table_free(free_cb, table_data, head)           \
    nsh_table_reg_t name = {.free       = free_cb,          \
                .get_first  = get_first_cb,     \
                .get_next   = get_next_cb,      \
                .idx        = index_list,       \
                .num_idx    = num_indexes,      \
                .min_column = NSH_DFLT_MIN_COLUMN,  \
                .max_column = num_table,        \
                .timeout    = NSH_DFLT_TIMEOUT,     \
    };

#endif /* NSH_H_ */