snmp_usm_mib_impl.h
Go to the documentation of this file.
1 /**
2  * @file snmp_usm_mib_impl.h
3  * @brief SNMP USM MIB module implementation
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2020 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  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.8
29  **/
30 
31 #ifndef _SNMP_USM_MIB_IMPL_H
32 #define _SNMP_USM_MIB_IMPL_H
33 
34 //Dependencies
35 #include "mibs/mib_common.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //SNMP USM MIB related functions
44 error_t snmpUsmMibLoad(void *context);
45 void snmpUsmMibUnload(void *context);
46 void snmpUsmMibLock(void);
47 void snmpUsmMibUnlock(void);
48 
49 error_t snmpUsmMibSetUserSpinLock(const MibObject *object, const uint8_t *oid,
50  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
51 
52 error_t snmpUsmMibGetUserSpinLock(const MibObject *object, const uint8_t *oid,
53  size_t oidLen, MibVariant *value, size_t *valueLen);
54 
55 error_t snmpUsmMibSetUserEntry(const MibObject *object, const uint8_t *oid,
56  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
57 
58 error_t snmpUsmMibGetUserEntry(const MibObject *object, const uint8_t *oid,
59  size_t oidLen, MibVariant *value, size_t *valueLen);
60 
61 error_t snmpUsmMibGetNextUserEntry(const MibObject *object, const uint8_t *oid,
62  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
63 
64 //C++ guard
65 #ifdef __cplusplus
66 }
67 #endif
68 
69 #endif
error_t snmpUsmMibSetUserSpinLock(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set usmUserSpinLock object value.
int bool_t
Definition: compiler_port.h:49
error_t
Error codes.
Definition: error.h:42
error_t snmpUsmMibSetUserEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set usmUserEntry object value.
uint8_t value[]
Definition: tcp.h:332
error_t snmpUsmMibLoad(void *context)
Load SNMP USM MIB module.
error_t snmpUsmMibGetUserSpinLock(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get usmUserSpinLock object value.
uint8_t oid[1]
Definition: mib_common.h:186
error_t snmpUsmMibGetNextUserEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next usmUserEntry object.
void snmpUsmMibUnload(void *context)
Unload SNMP USM MIB module.
__start_packed struct @103 MibVariant
Variant data type.
Common definitions for MIB modules.
error_t snmpUsmMibInit(void)
SNMP USM MIB module initialization.
error_t snmpUsmMibGetUserEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get usmUserEntry object value.
#define MibObject
Definition: mib_common.h:46
void snmpUsmMibLock(void)
Lock SNMP USM MIB base.
void snmpUsmMibUnlock(void)
Unlock SNMP USM MIB base.