snmp_agent_misc.h
Go to the documentation of this file.
1 /**
2  * @file snmp_agent_misc.h
3  * @brief Helper functions for SNMP agent
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 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 1.9.6
29  **/
30 
31 #ifndef _SNMP_AGENT_MISC_H
32 #define _SNMP_AGENT_MISC_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
44 void snmpLockMib(SnmpAgentContext *context);
45 void snmpUnlockMib(SnmpAgentContext *context);
46 
48 
50  const char_t *community, size_t length);
51 
52 error_t snmpParseVarBinding(const uint8_t *p,
53  size_t length, SnmpVarBind *var, size_t *consumed);
54 
57 
59  uint_t genericTrapType, uint_t specificTrapCode,
60  const SnmpTrapObject *objectList, uint_t objectListSize);
61 
63 
64 //C++ guard
65 #ifdef __cplusplus
66 }
67 #endif
68 
69 #endif
uint8_t length
Definition: dtls_misc.h:149
Variable binding.
error_t snmpParseVarBinding(const uint8_t *p, size_t length, SnmpVarBind *var, size_t *consumed)
Parse variable binding.
void snmpLockMib(SnmpAgentContext *context)
Lock MIB bases.
uint8_t p
Definition: ndp.h:298
Object descriptor for trap notifications.
User table entry.
SNMP agent (Simple Network Management Protocol)
error_t snmpCopyVarBindingList(SnmpAgentContext *context)
Copy the list of variable bindings.
error_t
Error codes.
Definition: error.h:42
SnmpUserEntry * snmpFindCommunityEntry(SnmpAgentContext *context, const char_t *community, size_t length)
Search the community table for a given community string.
void snmpUnlockMib(SnmpAgentContext *context)
Unlock MIB bases.
error_t snmpWriteTrapVarBindingList(SnmpAgentContext *context, uint_t genericTrapType, uint_t specificTrapCode, const SnmpTrapObject *objectList, uint_t objectListSize)
Format the variable binding list for Trap-PDU or SNMPv2-Trap-PDU.
error_t snmpWriteVarBinding(SnmpAgentContext *context, const SnmpVarBind *var)
Write variable binding.
char char_t
Definition: compiler_port.h:43
SnmpUserEntry * snmpCreateCommunityEntry(SnmpAgentContext *context)
Create a new community entry.
error_t snmpTranslateStatusCode(SnmpMessage *message, error_t status, uint_t index)
Translate status code.
uint8_t message[]
Definition: chap.h:152
SNMP message.
#define SnmpAgentContext
Definition: snmp_agent.h:36
unsigned int uint_t
Definition: compiler_port.h:45
TCP/IP stack core.