snmp_mib_impl.h
Go to the documentation of this file.
1 /**
2  * @file snmp_mib_impl.h
3  * @brief SNMP MIB module implementation
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _SNMP_MIB_IMPL_H
30 #define _SNMP_MIB_IMPL_H
31 
32 //Dependencies
33 #include "mibs/mib_common.h"
34 
35 //C++ guard
36 #ifdef __cplusplus
37  extern "C" {
38 #endif
39 
40 //SNMP MIB related functions
41 error_t snmpMibInit(void);
42 error_t snmpMibLoad(void *context);
43 void snmpMibUnload(void *context);
44 void snmpMibLock(void);
45 void snmpMibUnlock(void);
46 
47 error_t snmpMibGetSysDescr(const MibObject *object, const uint8_t *oid,
48  size_t oidLen, MibVariant *value, size_t *valueLen);
49 
50 error_t snmpMibGetSysObjectID(const MibObject *object, const uint8_t *oid,
51  size_t oidLen, MibVariant *value, size_t *valueLen);
52 
53 error_t snmpMibGetSysUpTime(const MibObject *object, const uint8_t *oid,
54  size_t oidLen, MibVariant *value, size_t *valueLen);
55 
56 error_t snmpMibSetSysContact(const MibObject *object, const uint8_t *oid,
57  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
58 
59 error_t snmpMibGetSysContact(const MibObject *object, const uint8_t *oid,
60  size_t oidLen, MibVariant *value, size_t *valueLen);
61 
62 error_t snmpMibSetSysName(const MibObject *object, const uint8_t *oid,
63  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
64 
65 error_t snmpMibGetSysName(const MibObject *object, const uint8_t *oid,
66  size_t oidLen, MibVariant *value, size_t *valueLen);
67 
68 error_t snmpMibSetSysLocation(const MibObject *object, const uint8_t *oid,
69  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
70 
71 error_t snmpMibGetSysLocation(const MibObject *object, const uint8_t *oid,
72  size_t oidLen, MibVariant *value, size_t *valueLen);
73 
74 error_t snmpMibGetSysOREntry(const MibObject *object, const uint8_t *oid,
75  size_t oidLen, MibVariant *value, size_t *valueLen);
76 
77 error_t snmpMibGetNextSysOREntry(const MibObject *object, const uint8_t *oid,
78  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
79 
80 error_t snmpv2MibGetSnmpTrapOID(const MibObject *object, const uint8_t *oid,
81  size_t oidLen, MibVariant *value, size_t *valueLen);
82 
83 error_t snmpv2MibGetSnmpTrapEnterprise(const MibObject *object, const uint8_t *oid,
84  size_t oidLen, MibVariant *value, size_t *valueLen);
85 
86 error_t snmpMibSetSnmpSetSerialNo(const MibObject *object, const uint8_t *oid,
87  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
88 
89 error_t snmpMibGetSnmpSetSerialNo(const MibObject *object, const uint8_t *oid,
90  size_t oidLen, MibVariant *value, size_t *valueLen);
91 
92 //C++ guard
93 #ifdef __cplusplus
94  }
95 #endif
96 
97 #endif
error_t snmpv2MibGetSnmpTrapOID(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpTrapOID object value.
error_t snmpMibGetSysOREntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get sysOREntry object value.
error_t snmpMibGetSysContact(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
error_t snmpMibSetSysContact(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
error_t snmpMibGetSysLocation(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
#define MibObject
Definition: mib_common.h:44
void snmpMibUnlock(void)
Unlock SNMP MIB base.
error_t snmpMibGetSysDescr(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
void snmpMibUnload(void *context)
Unload SNMP MIB module.
error_t snmpv2MibGetSnmpTrapEnterprise(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpTrapEnterprise object value.
error_t snmpMibGetSysUpTime(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get sysUpTime object value.
error_t snmpMibSetSysName(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
error_t snmpMibLoad(void *context)
Load SNMP MIB module.
error_t
Error codes.
Definition: error.h:40
__start_packed struct @208 MibVariant
Variant data type.
error_t snmpMibGetSysName(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
uint8_t value[]
Definition: dtls_misc.h:141
Common definitions for MIB modules.
void snmpMibLock(void)
Lock SNMP MIB base.
error_t snmpMibGetSnmpSetSerialNo(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpSetSerialNo object value.
error_t snmpMibGetNextSysOREntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next sysOREntry object.
error_t snmpMibGetSysObjectID(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
error_t snmpMibSetSysLocation(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
uint8_t oid[1]
Definition: mib_common.h:184
error_t snmpMibSetSnmpSetSerialNo(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set snmpSetSerialNo object value.
int bool_t
Definition: compiler_port.h:47
error_t snmpMibInit(void)
SNMP MIB module initialization.
Definition: snmp_mib_impl.c:52