rstp_mib_impl.h
Go to the documentation of this file.
1 /**
2  * @file rstp_mib_impl.h
3  * @brief RSTP MIB module implementation
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneSTP 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 _RSTP_MIB_IMPL_H
32 #define _RSTP_MIB_IMPL_H
33 
34 //Dependencies
35 #include "mibs/mib_common.h"
36 #include "rstp/rstp.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //RSTP MIB related functions
44 error_t rstpMibInit(void);
45 
47 
48 error_t rstpMibSetDot1dStpVersion(const MibObject *object, const uint8_t *oid,
49  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
50 
51 error_t rstpMibGetDot1dStpVersion(const MibObject *object, const uint8_t *oid,
52  size_t oidLen, MibVariant *value, size_t *valueLen);
53 
54 error_t rstpMibSetDot1dStpTxHoldCount(const MibObject *object, const uint8_t *oid,
55  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
56 
57 error_t rstpMibGetDot1dStpTxHoldCount(const MibObject *object, const uint8_t *oid,
58  size_t oidLen, MibVariant *value, size_t *valueLen);
59 
60 error_t rstpMibSetDot1dStpExtPortEntry(const MibObject *object, const uint8_t *oid,
61  size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit);
62 
63 error_t rstpMibGetDot1dStpExtPortEntry(const MibObject *object, const uint8_t *oid,
64  size_t oidLen, MibVariant *value, size_t *valueLen);
65 
66 error_t rstpMibGetNextDot1dStpExtPortEntry(const MibObject *object, const uint8_t *oid,
67  size_t oidLen, uint8_t *nextOid, size_t *nextOidLen);
68 
69 //C++ guard
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif
int bool_t
Definition: compiler_port.h:53
error_t
Error codes.
Definition: error.h:43
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
RSTP (Rapid Spanning Tree Protocol)
#define RstpBridgeContext
Definition: rstp.h:36
error_t rstpMibSetDot1dStpExtPortEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set dot1dStpExtPortEntry object value.
error_t rstpMibSetRstpBridgeContext(RstpBridgeContext *context)
Attach RSTP bridge context.
Definition: rstp_mib_impl.c:74
error_t rstpMibGetDot1dStpVersion(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get dot1dStpVersion object value.
error_t rstpMibGetDot1dStpExtPortEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get dot1dStpExtPortEntry object value.
error_t rstpMibSetDot1dStpTxHoldCount(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set dot1dStpTxHoldCount object value.
error_t rstpMibSetDot1dStpVersion(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set dot1dStpVersion object value.
Definition: rstp_mib_impl.c:96
error_t rstpMibInit(void)
RSTP MIB module initialization.
Definition: rstp_mib_impl.c:55
error_t rstpMibGetDot1dStpTxHoldCount(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get dot1dStpTxHoldCount object value.
error_t rstpMibGetNextDot1dStpExtPortEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next dot1dStpExtPortEntry object.
uint8_t value[]
Definition: tcp.h:369