Contiki-NG
Loading...
Searching...
No Matches
snmp-conf.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2019-2020 Yago Fontoura do Rosario <yago.rosario@hotmail.com.br>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * 3. Neither the name of the copyright holder nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29 * OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31/*---------------------------------------------------------------------------*/
32
33/**
34 * \file
35 * SNMP Implementation of the configurable macros
36 * \author
37 * Yago Fontoura do Rosario <yago.rosario@hotmail.com.br
38 */
39
40/**
41 * \addtogroup snmp
42 * @{
43 */
44
45#ifndef SNMP_CONF_H_
46#define SNMP_CONF_H_
47
48/**
49 * \addtogroup SNMPInternal SNMP Internal API
50 * @{
51 *
52 * This group contains all the functions that can be used inside the OS level.
53 */
54
55/**
56 * \addtogroup SNMPConfs SNMP Configurable
57 * @{
58 *
59 * This group contains all the defines that can be configurable following the Contiki standard
60 */
61
62#ifdef SNMP_CONF_COMMUNITY
63/**
64 * \brief Configurable SNMP Community
65 */
66#define SNMP_COMMUNITY SNMP_CONF_COMMUNITY
67#else
68/**
69 * \brief Default SNMP Community
70 */
71#define SNMP_COMMUNITY "public"
72#endif
73
74#ifdef SNMP_CONF_MSG_OID_MAX_LEN
75#if SNMP_CONF_MSG_OID_MAX_LEN > 128
76#error "OID is limited to 128 in the standard"
77#endif
78/**
79 * \brief Configurable maximum number of IDs in one OID
80 */
81#define SNMP_MSG_OID_MAX_LEN SNMP_CONF_MSG_OID_MAX_LEN
82#else
83/**
84 * \brief Default maximum number of IDs in one OID
85 */
86#define SNMP_MSG_OID_MAX_LEN 16
87#endif
88
89#ifdef SNMP_CONF_MAX_NR_VALUES
90#if SNMP_CONF_MAX_NR_VALUES > 255
91#error "Number of OID's per packet is limited to 255 in this implementation"
92#endif
93/**
94 * \brief Configurable maximum number of OIDs in one response
95 */
96#define SNMP_MAX_NR_VALUES SNMP_CONF_MAX_NR_VALUES
97#else
98/**
99 * \brief Default maximum number of OIDs in one response
100 */
101#define SNMP_MAX_NR_VALUES 2
102#endif
103
104#ifdef SNMP_CONF_MAX_PACKET_SIZE
105#error "SNMP_CONF_MAX_PACKET_SIZE is obsolete. Use UIP_CONF_BUFFER_SIZE"
106#endif /* SNMP_CONF_MAX_PACKET_SIZE */
107
108#ifdef SNMP_CONF_PORT
109/**
110 * \brief Configurable SNMP port
111 */
112#define SNMP_PORT SNMP_CONF_PORT
113#else
114/**
115 * \brief Default SNMP port
116 */
117#define SNMP_PORT 161
118#endif
119
120/** @} */
121
122/** @} */
123
124#endif /* SNMP_CONF_H_ */
125
126/** @} */