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  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _SNMP_AGENT_MISC_H
30 #define _SNMP_AGENT_MISC_H
31 
32 //Dependencies
33 #include "core/net.h"
34 #include "snmp/snmp_agent.h"
35 
36 //C++ guard
37 #ifdef __cplusplus
38  extern "C" {
39 #endif
40 
41 //SNMP agent related functions
42 void snmpLockMib(SnmpAgentContext *context);
43 void snmpUnlockMib(SnmpAgentContext *context);
44 
46 
48  const char_t *community, size_t length);
49 
50 error_t snmpParseVarBinding(const uint8_t *p,
51  size_t length, SnmpVarBind *var, size_t *consumed);
52 
55 
57  uint_t genericTrapType, uint_t specificTrapCode,
58  const SnmpTrapObject *objectList, uint_t objectListSize);
59 
61 
62 //C++ guard
63 #ifdef __cplusplus
64  }
65 #endif
66 
67 #endif
char char_t
Definition: compiler_port.h:41
void snmpUnlockMib(SnmpAgentContext *context)
Unlock MIB bases.
TCP/IP stack core.
uint8_t p
Definition: ndp.h:295
uint8_t message[]
Definition: chap.h:150
error_t snmpParseVarBinding(const uint8_t *p, size_t length, SnmpVarBind *var, size_t *consumed)
Parse variable binding.
User table entry.
Variable binding.
SnmpUserEntry * snmpCreateCommunityEntry(SnmpAgentContext *context)
Create a new community entry.
SNMP agent (Simple Network Management Protocol)
void snmpLockMib(SnmpAgentContext *context)
Lock MIB bases.
error_t snmpWriteVarBinding(SnmpAgentContext *context, const SnmpVarBind *var)
Write variable binding.
error_t snmpCopyVarBindingList(SnmpAgentContext *context)
Copy the list of variable bindings.
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.
SnmpUserEntry * snmpFindCommunityEntry(SnmpAgentContext *context, const char_t *community, size_t length)
Search the community table for a given community string.
error_t
Error codes.
Definition: error.h:40
SNMP message.
unsigned int uint_t
Definition: compiler_port.h:43
Object descriptor for trap notifications.
error_t snmpTranslateStatusCode(SnmpMessage *message, error_t status, uint_t index)
Translate status code.
#define SnmpAgentContext
Definition: snmp_agent.h:34
uint8_t length
Definition: dtls_misc.h:140