Functions
snmp_usm_mib_impl.h File Reference

SNMP USM MIB module implementation. More...

#include "mibs/mib_common.h"

Go to the source code of this file.

Functions

error_t snmpUsmMibInit (void)
 SNMP USM MIB module initialization. More...
 
error_t snmpUsmMibLoad (void *context)
 Load SNMP USM MIB module. More...
 
void snmpUsmMibUnload (void *context)
 Unload SNMP USM MIB module. More...
 
void snmpUsmMibLock (void)
 Lock SNMP USM MIB base. More...
 
void snmpUsmMibUnlock (void)
 Unlock SNMP USM MIB base. More...
 
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. More...
 
error_t snmpUsmMibGetUserSpinLock (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get usmUserSpinLock object value. More...
 
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. More...
 
error_t snmpUsmMibGetUserEntry (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get usmUserEntry object value. More...
 
error_t snmpUsmMibGetNextUserEntry (const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
 Get next usmUserEntry object. More...
 

Detailed Description

SNMP USM MIB module implementation.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.5.4

Definition in file snmp_usm_mib_impl.h.

Function Documentation

◆ snmpUsmMibGetNextUserEntry()

error_t snmpUsmMibGetNextUserEntry ( const MibObject *  object,
const uint8_t *  oid,
size_t  oidLen,
uint8_t *  nextOid,
size_t *  nextOidLen 
)

Get next usmUserEntry object.

Parameters
[in]objectPointer to the MIB object descriptor
[in]oidObject identifier
[in]oidLenLength of the OID, in bytes
[out]nextOidOID of the next object in the MIB
[out]nextOidLenLength of the next object identifier, in bytes
Returns
Error code

Definition at line 1054 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibGetUserEntry()

error_t snmpUsmMibGetUserEntry ( const MibObject *  object,
const uint8_t *  oid,
size_t  oidLen,
MibVariant *  value,
size_t *  valueLen 
)

Get usmUserEntry object value.

Parameters
[in]objectPointer to the MIB object descriptor
[in]oidObject identifier (object name and instance identifier)
[in]oidLenLength of the OID, in bytes
[out]valueObject value
[in,out]valueLenLength of the object value, in bytes
Returns
Error code

Definition at line 785 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibGetUserSpinLock()

error_t snmpUsmMibGetUserSpinLock ( const MibObject *  object,
const uint8_t *  oid,
size_t  oidLen,
MibVariant *  value,
size_t *  valueLen 
)

Get usmUserSpinLock object value.

Parameters
[in]objectPointer to the MIB object descriptor
[in]oidObject identifier (object name and instance identifier)
[in]oidLenLength of the OID, in bytes
[out]valueObject value
[in,out]valueLenLength of the object value, in bytes
Returns
Error code

Definition at line 176 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibInit()

error_t snmpUsmMibInit ( void  )

SNMP USM MIB module initialization.

Returns
Error code

Definition at line 79 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibLoad()

error_t snmpUsmMibLoad ( void *  context)

Load SNMP USM MIB module.

Parameters
[in]contextPointer to the SNMP agent context
Returns
Error code

Definition at line 101 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibLock()

void snmpUsmMibLock ( void  )

Lock SNMP USM MIB base.

Definition at line 127 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibSetUserEntry()

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.

Parameters
[in]objectPointer to the MIB object descriptor
[in]oidObject identifier (object name and instance identifier)
[in]oidLenLength of the OID, in bytes
[in]valueObject value
[in]valueLenLength of the object value, in bytes
[in]commitThis flag tells whether the changes shall be committed to the MIB base
Returns
Error code

Definition at line 199 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibSetUserSpinLock()

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.

Parameters
[in]objectPointer to the MIB object descriptor
[in]oidObject identifier (object name and instance identifier)
[in]oidLenLength of the OID, in bytes
[in]valueObject value
[in]valueLenLength of the object value, in bytes
[in]commitThis flag tells whether the changes shall be committed to the MIB base
Returns
Error code

Definition at line 157 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibUnload()

void snmpUsmMibUnload ( void *  context)

Unload SNMP USM MIB module.

Parameters
[in]contextPointer to the SNMP agent context

Definition at line 116 of file snmp_usm_mib_impl.c.

◆ snmpUsmMibUnlock()

void snmpUsmMibUnlock ( void  )

Unlock SNMP USM MIB base.

Definition at line 138 of file snmp_usm_mib_impl.c.