snmp_agent_trap.h
Go to the documentation of this file.
1 /**
2  * @file snmp_agent_trap.h
3  * @brief SNMP trap notifications
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_TRAP_H
30 #define _SNMP_AGENT_TRAP_H
31 
32 //Dependencies
33 #include "core/net.h"
34 #include "snmp/snmp_agent.h"
35 
36 //Trap notification support
37 #ifndef SNMP_AGENT_TRAP_SUPPORT
38  #define SNMP_AGENT_TRAP_SUPPORT ENABLED
39 #elif (SNMP_AGENT_TRAP_SUPPORT != ENABLED && SNMP_AGENT_TRAP_SUPPORT != DISABLED)
40  #error SNMP_AGENT_TRAP_SUPPORT parameter is not valid
41 #endif
42 
43 //C++ guard
44 #ifdef __cplusplus
45  extern "C" {
46 #endif
47 
48 
49 /**
50  * @brief Object descriptor for trap notifications
51  **/
52 
53 typedef struct
54 {
56  size_t oidLen;
58 
59 
60 //SNMP trap related functions
62  const char_t *userName, uint_t genericTrapType, uint_t specificTrapCode,
63  const SnmpTrapObject *objectList, uint_t objectListSize);
64 
66  const char_t *userName, uint_t genericTrapType, uint_t specificTrapCode,
67  const SnmpTrapObject *objectList, uint_t objectListSize);
68 
69 //C++ guard
70 #ifdef __cplusplus
71  }
72 #endif
73 
74 #endif
uint16_t version
Definition: dtls_misc.h:163
char char_t
Definition: compiler_port.h:41
TCP/IP stack core.
#define SNMP_MAX_OID_SIZE
Definition: snmp_common.h:114
SnmpVersion
SNMP version identifiers.
Definition: snmp_common.h:134
error_t snmpFormatTrapPdu(SnmpAgentContext *context, SnmpVersion version, const char_t *userName, uint_t genericTrapType, uint_t specificTrapCode, const SnmpTrapObject *objectList, uint_t objectListSize)
Format Trap-PDU or SNMPv2-Trap-PDU.
SNMP agent (Simple Network Management Protocol)
error_t
Error codes.
Definition: error.h:40
unsigned int uint_t
Definition: compiler_port.h:43
Object descriptor for trap notifications.
error_t snmpFormatTrapMessage(SnmpAgentContext *context, SnmpVersion version, const char_t *userName, uint_t genericTrapType, uint_t specificTrapCode, const SnmpTrapObject *objectList, uint_t objectListSize)
Format SNMP Trap message.
#define SnmpAgentContext
Definition: snmp_agent.h:34
uint8_t oid[1]
Definition: mib_common.h:184