snmp_community_mib_impl.h File Reference

SNMP COMMUNITY MIB module implementation. More...

#include "mibs/mib_common.h"

Go to the source code of this file.

Functions

error_t snmpCommunityMibInit (void)
 SNMP COMMUNITY MIB module initialization. More...
 
error_t snmpCommunityMibLoad (void *context)
 Load SNMP COMMUNITY MIB module. More...
 
void snmpCommunityMibUnload (void *context)
 Unload SNMP COMMUNITY MIB module. More...
 
void snmpCommunityMibLock (void)
 Lock SNMP COMMUNITY MIB base. More...
 
void snmpCommunityMibUnlock (void)
 Unlock SNMP COMMUNITY MIB base. More...
 
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. More...
 
error_t snmpCommunityMibGetCommunityEntry (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get snmpCommunityEntry object value. More...
 
error_t snmpCommunityMibGetNextCommunityEntry (const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
 Get next snmpCommunityEntry object. More...
 

Detailed Description

SNMP COMMUNITY MIB module implementation.

License

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

Copyright (C) 2010-2024 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.

Description

The SNMP-MIB describes managed objects which describe the behavior of an SNMP entity. Refer to RFC 3418 for more details

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

Definition in file snmp_community_mib_impl.h.

Function Documentation

◆ snmpCommunityMibGetCommunityEntry()

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

Get snmpCommunityEntry 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 373 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibGetNextCommunityEntry()

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

Get next snmpCommunityEntry 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 528 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibInit()

error_t snmpCommunityMibInit ( void  )

SNMP COMMUNITY MIB module initialization.

Returns
Error code

Definition at line 60 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibLoad()

error_t snmpCommunityMibLoad ( void *  context)

Load SNMP COMMUNITY MIB module.

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

Definition at line 79 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibLock()

void snmpCommunityMibLock ( void  )

Lock SNMP COMMUNITY MIB base.

Definition at line 105 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibSetCommunityEntry()

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.

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 135 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibUnload()

void snmpCommunityMibUnload ( void *  context)

Unload SNMP COMMUNITY MIB module.

Parameters
[in]contextPointer to the SNMP agent context

Definition at line 94 of file snmp_community_mib_impl.c.

◆ snmpCommunityMibUnlock()

void snmpCommunityMibUnlock ( void  )

Unlock SNMP COMMUNITY MIB base.

Definition at line 116 of file snmp_community_mib_impl.c.