snmp_mib_impl.h File Reference

SNMP MIB module implementation. More...

#include "mibs/mib_common.h"

Go to the source code of this file.

Functions

error_t snmpMibInit (void)
 SNMP MIB module initialization. More...
 
error_t snmpMibLoad (void *context)
 Load SNMP MIB module. More...
 
void snmpMibUnload (void *context)
 Unload SNMP MIB module. More...
 
void snmpMibLock (void)
 Lock SNMP MIB base. More...
 
void snmpMibUnlock (void)
 Unlock SNMP MIB base. More...
 
error_t snmpMibGetSysDescr (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 
error_t snmpMibGetSysObjectID (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 
error_t snmpMibGetSysUpTime (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get sysUpTime object value. More...
 
error_t snmpMibSetSysContact (const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
 
error_t snmpMibGetSysContact (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 
error_t snmpMibSetSysName (const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
 
error_t snmpMibGetSysName (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)
 
error_t snmpMibGetSysLocation (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 
error_t snmpMibGetSysOREntry (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get sysOREntry object value. More...
 
error_t snmpMibGetNextSysOREntry (const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
 Get next sysOREntry object. More...
 
error_t snmpv2MibGetSnmpTrapOID (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get snmpTrapOID object value. More...
 
error_t snmpv2MibGetSnmpTrapEnterprise (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get snmpTrapEnterprise object value. More...
 
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. More...
 
error_t snmpMibGetSnmpSetSerialNo (const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get snmpSetSerialNo object value. More...
 

Detailed Description

SNMP MIB module implementation.

License

Copyright (C) 2010-2018 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
1.9.0

Definition in file snmp_mib_impl.h.

Function Documentation

◆ snmpMibGetNextSysOREntry()

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

Get next sysOREntry 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 290 of file snmp_mib_impl.c.

◆ snmpMibGetSnmpSetSerialNo()

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

Get snmpSetSerialNo 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 433 of file snmp_mib_impl.c.

◆ snmpMibGetSysContact()

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

◆ snmpMibGetSysDescr()

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

◆ snmpMibGetSysLocation()

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

◆ snmpMibGetSysName()

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

◆ snmpMibGetSysObjectID()

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

◆ snmpMibGetSysOREntry()

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

Get sysOREntry 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 187 of file snmp_mib_impl.c.

◆ snmpMibGetSysUpTime()

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

Get sysUpTime 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 166 of file snmp_mib_impl.c.

◆ snmpMibInit()

error_t snmpMibInit ( void  )

SNMP MIB module initialization.

Returns
Error code

Definition at line 52 of file snmp_mib_impl.c.

◆ snmpMibLoad()

error_t snmpMibLoad ( void *  context)

Load SNMP MIB module.

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

Definition at line 116 of file snmp_mib_impl.c.

◆ snmpMibLock()

void snmpMibLock ( void  )

Lock SNMP MIB base.

Definition at line 142 of file snmp_mib_impl.c.

◆ snmpMibSetSnmpSetSerialNo()

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.

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 414 of file snmp_mib_impl.c.

◆ snmpMibSetSysContact()

error_t snmpMibSetSysContact ( const MibObject object,
const uint8_t *  oid,
size_t  oidLen,
const MibVariant value,
size_t  valueLen,
bool_t  commit 
)

◆ snmpMibSetSysLocation()

error_t snmpMibSetSysLocation ( const MibObject object,
const uint8_t *  oid,
size_t  oidLen,
const MibVariant value,
size_t  valueLen,
bool_t  commit 
)

◆ snmpMibSetSysName()

error_t snmpMibSetSysName ( const MibObject object,
const uint8_t *  oid,
size_t  oidLen,
const MibVariant value,
size_t  valueLen,
bool_t  commit 
)

◆ snmpMibUnload()

void snmpMibUnload ( void *  context)

Unload SNMP MIB module.

Parameters
[in]contextPointer to the SNMP agent context

Definition at line 131 of file snmp_mib_impl.c.

◆ snmpMibUnlock()

void snmpMibUnlock ( void  )

Unlock SNMP MIB base.

Definition at line 151 of file snmp_mib_impl.c.

◆ snmpv2MibGetSnmpTrapEnterprise()

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

Get snmpTrapEnterprise 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 375 of file snmp_mib_impl.c.

◆ snmpv2MibGetSnmpTrapOID()

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

Get snmpTrapOID 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 354 of file snmp_mib_impl.c.