snmp_agent_misc.h

00001 /**
00002  * @file snmp_agent_misc.h
00003  * @brief SNMP agent (miscellaneous functions)
00004  *
00005  * @section License
00006  *
00007  * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
00008  *
00009  * This file is part of CycloneTCP Open.
00010  *
00011  * This program is free software; you can redistribute it and/or
00012  * modify it under the terms of the GNU General Public License
00013  * as published by the Free Software Foundation; either version 2
00014  * of the License, or (at your option) any later version.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * along with this program; if not, write to the Free Software Foundation,
00023  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00024  *
00025  * @author Oryx Embedded SARL (www.oryx-embedded.com)
00026  * @version 1.7.6
00027  **/
00028 
00029 #ifndef _SNMP_AGENT_MISC_H
00030 #define _SNMP_AGENT_MISC_H
00031 
00032 //Dependencies
00033 #include "core/net.h"
00034 #include "snmp/snmp_agent.h"
00035 
00036 //SNMP agent related functions
00037 void snmpLockMib(SnmpAgentContext *context);
00038 void snmpUnlockMib(SnmpAgentContext *context);
00039 
00040 error_t snmpInitResponse(SnmpAgentContext *context);
00041 
00042 void snmpRefreshEngineTime(SnmpAgentContext *context);
00043 error_t snmpCheckEngineTime(SnmpAgentContext *context, SnmpMessage *message);
00044 
00045 SnmpUserInfo *snmpFindUser(SnmpAgentContext *context,
00046    const char_t *name, size_t length);
00047 
00048 error_t snmpParseVarBinding(const uint8_t *p,
00049    size_t length, SnmpVarBind *var, size_t *consumed);
00050 
00051 error_t snmpWriteVarBinding(SnmpAgentContext *context, const SnmpVarBind *var);
00052 error_t snmpCopyVarBindingList(SnmpAgentContext *context);
00053 
00054 error_t snmpSetObjectValue(SnmpAgentContext *context, SnmpVarBind *var, bool_t commit);
00055 error_t snmpGetObjectValue(SnmpAgentContext *context, SnmpVarBind *var);
00056 error_t snmpGetNextObject(SnmpAgentContext *context, SnmpVarBind *var);
00057 
00058 error_t snmpFindMibObject(SnmpAgentContext *context,
00059    const uint8_t *oid, size_t oidLen, const MibObject **object);
00060 
00061 error_t snmpTranslateStatusCode(SnmpMessage *message, error_t status, uint_t index);
00062 
00063 #endif
00064