mib2_impl_sys.h
Go to the documentation of this file.
1 /**
2  * @file mib2_impl_sys.h
3  * @brief MIB-II module implementation (System group)
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.0
29  **/
30 
31 #ifndef _MIB2_IMPL_SYS_H
32 #define _MIB2_IMPL_SYS_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "mibs/mib2_module.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //MIB-II related functions
44 error_t mib2GetSysObjectID(const MibObject *object, const uint8_t *oid,
45  size_t oidLen, MibVariant *value, size_t *valueLen);
46 
47 error_t mib2GetSysUpTime(const MibObject *object, const uint8_t *oid,
48  size_t oidLen, MibVariant *value, size_t *valueLen);
49 
50 error_t mib2SetSysContact(const MibObject *object, const uint8_t *oid,
51  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
52 
53 error_t mib2GetSysContact(const MibObject *object, const uint8_t *oid,
54  size_t oidLen, MibVariant *value, size_t *valueLen);
55 
56 error_t mib2SetSysName(const MibObject *object, const uint8_t *oid,
57  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
58 
59 error_t mib2GetSysName(const MibObject *object, const uint8_t *oid,
60  size_t oidLen, MibVariant *value, size_t *valueLen);
61 
62 error_t mib2SetSysLocation(const MibObject *object, const uint8_t *oid,
63  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
64 
65 error_t mib2GetSysLocation(const MibObject *object, const uint8_t *oid,
66  size_t oidLen, MibVariant *value, size_t *valueLen);
67 
68 //C++ guard
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif
bool_t
int bool_t
Definition: compiler_port.h:53
error_t
error_t
Error codes.
Definition: error.h:43
oid
uint8_t oid[]
Definition: lldp_tlv.h:300
oidLen
uint8_t oidLen
Definition: lldp_tlv.h:299
mib2GetSysUpTime
error_t mib2GetSysUpTime(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get sysUpTime object value.
Definition: mib2_impl_sys.c:59
mib2GetSysObjectID
error_t mib2GetSysObjectID(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
mib2GetSysContact
error_t mib2GetSysContact(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
mib2SetSysContact
error_t mib2SetSysContact(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
mib2GetSysName
error_t mib2GetSysName(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
mib2GetSysLocation
error_t mib2GetSysLocation(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
mib2SetSysName
error_t mib2SetSysName(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
mib2SetSysLocation
error_t mib2SetSysLocation(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
mib2_module.h
MIB-II module.
MibObject
#define MibObject
Definition: mib_common.h:46
MibVariant
MibVariant
Definition: mib_common.h:196
net.h
TCP/IP stack core.
value
uint8_t value[]
Definition: tcp.h:369