snmp_core_priv.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  *
00029  * Author: Martin Hentschel <info@cl-soft.de>
00030  *
00031  */
00032 
00033 #ifndef LWIP_HDR_APPS_SNMP_CORE_PRIV_H
00034 #define LWIP_HDR_APPS_SNMP_CORE_PRIV_H
00035 
00036 #include "lwip/apps/snmp_opts.h"
00037 
00038 #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */
00039 
00040 #include "lwip/apps/snmp_core.h"
00041 #include "snmp_asn1.h"
00042 
00043 #ifdef __cplusplus
00044 extern "C" {
00045 #endif
00046 
00047 /* (outdated) SNMPv1 error codes
00048  * shall not be used by MIBS anymore, nevertheless required from core for properly answering a v1 request
00049  */
00050 #define SNMP_ERR_NOSUCHNAME 2
00051 #define SNMP_ERR_BADVALUE   3
00052 #define SNMP_ERR_READONLY   4
00053 /* error codes which are internal and shall not be used by MIBS
00054  * shall not be used by MIBS anymore, nevertheless required from core for properly answering a v1 request
00055  */
00056 #define SNMP_ERR_TOOBIG               1
00057 #define SNMP_ERR_AUTHORIZATIONERROR   16
00058 #define SNMP_ERR_NOSUCHOBJECT         SNMP_VARBIND_EXCEPTION_OFFSET + SNMP_ASN1_CONTEXT_VARBIND_NO_SUCH_OBJECT
00059 #define SNMP_ERR_ENDOFMIBVIEW         SNMP_VARBIND_EXCEPTION_OFFSET + SNMP_ASN1_CONTEXT_VARBIND_END_OF_MIB_VIEW
00060 
00061 
00062 const struct snmp_node* snmp_mib_tree_resolve_exact(const struct snmp_mib *mib, const u32_t *oid, u8_t oid_len, u8_t* oid_instance_len);
00063 const struct snmp_node* snmp_mib_tree_resolve_next(const struct snmp_mib *mib, const u32_t *oid, u8_t oid_len, struct snmp_obj_id* oidret);
00064 
00065 typedef u8_t (*snmp_validate_node_instance_method)(struct snmp_node_instance*, void*);
00066 
00067 u8_t snmp_get_node_instance_from_oid(const u32_t *oid, u8_t oid_len, struct snmp_node_instance* node_instance);
00068 u8_t snmp_get_next_node_instance_from_oid(const u32_t *oid, u8_t oid_len, snmp_validate_node_instance_method validate_node_instance_method, void* validate_node_instance_arg, struct snmp_obj_id* node_oid, struct snmp_node_instance* node_instance);
00069 
00070 #ifdef __cplusplus
00071 }
00072 #endif
00073 
00074 #endif /* LWIP_SNMP */
00075 
00076 #endif /* LWIP_HDR_APPS_SNMP_CORE_PRIV_H */