snmp_agent_object.h
Go to the documentation of this file.
1 /**
2  * @file snmp_agent_object.h
3  * @brief MIB object access
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 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 2.4.4
29  **/
30 
31 #ifndef _SNMP_AGENT_OBJECT_H
32 #define _SNMP_AGENT_OBJECT_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "snmp/snmp_agent.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //SNMP agent related functions
45  const SnmpMessage *message, SnmpVarBind *var, bool_t commit);
46 
48  const SnmpMessage *message, SnmpVarBind *var);
49 
51  const SnmpMessage *message, SnmpVarBind *var);
52 
54  const uint8_t *oid, size_t oidLen, const MibObject **object);
55 
56 //C++ guard
57 #ifdef __cplusplus
58 }
59 #endif
60 
61 #endif
int bool_t
Definition: compiler_port.h:53
Variable binding.
uint8_t message[]
Definition: chap.h:154
error_t snmpGetNextObject(SnmpAgentContext *context, const SnmpMessage *message, SnmpVarBind *var)
Search MIBs for the next object.
uint8_t oid[]
Definition: lldp_tlv.h:300
SNMP agent (Simple Network Management Protocol)
error_t
Error codes.
Definition: error.h:43
error_t snmpGetObjectValue(SnmpAgentContext *context, const SnmpMessage *message, SnmpVarBind *var)
Retrieve object value.
#define MibObject
Definition: mib_common.h:46
uint8_t oidLen
Definition: lldp_tlv.h:299
error_t snmpSetObjectValue(SnmpAgentContext *context, const SnmpMessage *message, SnmpVarBind *var, bool_t commit)
Assign object value.
SNMP message.
#define SnmpAgentContext
Definition: snmp_agent.h:36
error_t snmpFindMibObject(SnmpAgentContext *context, const uint8_t *oid, size_t oidLen, const MibObject **object)
Search MIBs for the given object.
TCP/IP stack core.