snmp_community_mib_impl.h
Go to the documentation of this file.
1 /**
2  * @file snmp_community_mib_impl.h
3  * @brief SNMP COMMUNITY MIB module implementation
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @section Description
28  *
29  * The SNMP-MIB describes managed objects which describe the behavior
30  * of an SNMP entity. Refer to RFC 3418 for more details
31  *
32  * @author Oryx Embedded SARL (www.oryx-embedded.com)
33  * @version 2.4.0
34  **/
35 
36 #ifndef _SNMP_COMMUNITY_MIB_IMPL_H
37 #define _SNMP_COMMUNITY_MIB_IMPL_H
38 
39 //Dependencies
40 #include "mibs/mib_common.h"
41 
42 //C++ guard
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 //SNMP COMMUNITY MIB related functions
49 error_t snmpCommunityMibLoad(void *context);
50 void snmpCommunityMibUnload(void *context);
51 void snmpCommunityMibLock(void);
52 void snmpCommunityMibUnlock(void);
53 
54 error_t snmpCommunityMibSetCommunityEntry(const MibObject *object, const uint8_t *oid,
55  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
56 
57 error_t snmpCommunityMibGetCommunityEntry(const MibObject *object, const uint8_t *oid,
58  size_t oidLen, MibVariant *value, size_t *valueLen);
59 
60 error_t snmpCommunityMibGetNextCommunityEntry(const MibObject *object, const uint8_t *oid,
61  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
62 
63 //C++ guard
64 #ifdef __cplusplus
65 }
66 #endif
67 
68 #endif
int bool_t
Definition: compiler_port.h:53
error_t
Error codes.
Definition: error.h:43
uint8_t oid[]
Definition: lldp_tlv.h:300
uint8_t oidLen
Definition: lldp_tlv.h:299
Common definitions for MIB modules.
#define MibObject
Definition: mib_common.h:46
MibVariant
Definition: mib_common.h:196
error_t snmpCommunityMibInit(void)
SNMP COMMUNITY MIB module initialization.
void snmpCommunityMibUnload(void *context)
Unload SNMP COMMUNITY MIB module.
error_t snmpCommunityMibGetNextCommunityEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next snmpCommunityEntry object.
void snmpCommunityMibUnlock(void)
Unlock SNMP COMMUNITY MIB base.
error_t snmpCommunityMibSetCommunityEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set snmpCommunityEntry object value.
error_t snmpCommunityMibLoad(void *context)
Load SNMP COMMUNITY MIB module.
error_t snmpCommunityMibGetCommunityEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpCommunityEntry object value.
void snmpCommunityMibLock(void)
Lock SNMP COMMUNITY MIB base.
uint8_t value[]
Definition: tcp.h:369