if_mib_impl.h
Go to the documentation of this file.
1 /**
2  * @file if_mib_impl.h
3  * @brief Interfaces Group MIB module implementation
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 _IF_MIB_IMPL_H
32 #define _IF_MIB_IMPL_H
33 
34 //Dependencies
35 #include "mibs/mib_common.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //Interfaces Group MIB related functions
43 error_t ifMibInit(void);
44 
45 error_t ifMibSetIfEntry(const MibObject *object, const uint8_t *oid,
46  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
47 
48 error_t ifMibGetIfEntry(const MibObject *object, const uint8_t *oid,
49  size_t oidLen, MibVariant *value, size_t *valueLen);
50 
51 error_t ifMibGetNextIfEntry(const MibObject *object, const uint8_t *oid,
52  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
53 
54 error_t ifMibSetIfXEntry(const MibObject *object, const uint8_t *oid,
55  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
56 
57 error_t ifMibGetIfXEntry(const MibObject *object, const uint8_t *oid,
58  size_t oidLen, MibVariant *value, size_t *valueLen);
59 
60 error_t ifMibGetNextIfXEntry(const MibObject *object, const uint8_t *oid,
61  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
62 
63 error_t ifMibSetIfStackEntry(const MibObject *object, const uint8_t *oid,
64  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
65 
66 error_t ifMibGetIfStackEntry(const MibObject *object, const uint8_t *oid,
67  size_t oidLen, MibVariant *value, size_t *valueLen);
68 
69 error_t ifMibGetNextIfStackEntry(const MibObject *object, const uint8_t *oid,
70  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
71 
72 error_t ifMibSetIfRcvAddressEntry(const MibObject *object, const uint8_t *oid,
73  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
74 
75 error_t ifMibGetIfRcvAddressEntry(const MibObject *object, const uint8_t *oid,
76  size_t oidLen, MibVariant *value, size_t *valueLen);
77 
78 error_t ifMibGetNextIfRcvAddressEntry(const MibObject *object, const uint8_t *oid,
79  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
80 
81 //C++ guard
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif
int bool_t
Definition: compiler_port.h:53
error_t
Error codes.
Definition: error.h:43
error_t ifMibSetIfXEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set ifXEntry object value.
Definition: if_mib_impl.c:423
error_t ifMibSetIfRcvAddressEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set ifRcvAddressEntry object value.
Definition: if_mib_impl.c:851
error_t ifMibSetIfStackEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set ifStackEntry object value.
Definition: if_mib_impl.c:678
error_t ifMibGetNextIfRcvAddressEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next ifRcvAddressEntry object.
Definition: if_mib_impl.c:995
error_t ifMibGetIfEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get ifEntry object value.
Definition: if_mib_impl.c:112
error_t ifMibGetNextIfStackEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next ifStackEntry object.
Definition: if_mib_impl.c:770
error_t ifMibGetIfStackEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get ifStackEntry object value.
Definition: if_mib_impl.c:696
error_t ifMibInit(void)
Interfaces Group MIB module initialization.
Definition: if_mib_impl.c:53
error_t ifMibGetNextIfEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next ifEntry object.
Definition: if_mib_impl.c:368
error_t ifMibGetNextIfXEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next ifXEntry object.
Definition: if_mib_impl.c:623
error_t ifMibGetIfXEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get ifXEntry object value.
Definition: if_mib_impl.c:441
error_t ifMibGetIfRcvAddressEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get ifRcvAddressEntry object value.
Definition: if_mib_impl.c:869
error_t ifMibSetIfEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set ifEntry object value.
Definition: if_mib_impl.c:94
uint8_t oid[]
Definition: lldp_tlv.h:300
uint8_t oidLen
Definition: lldp_tlv.h:299
Common definitions for MIB modules.
#define MibObject
Definition: mib_common.h:46
MibVariant
Definition: mib_common.h:196
uint8_t value[]
Definition: tcp.h:369