stp_conditions.h
Go to the documentation of this file.
1 /**
2  * @file stp_conditions.h
3  * @brief STP algorithm conditions
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 _STP_CONDITIONS_H
32 #define _STP_CONDITIONS_H
33 
34 //Dependencies
35 #include "stp/stp.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //STP related functions
43 bool_t stpRootBridge(StpBridgeContext *context);
44 bool_t stpDesignatedBridge(StpBridgeContext *context);
45 bool_t stpRootPort(StpBridgePort *port);
46 bool_t stpDesignatedPort(StpBridgePort *port);
47 bool_t stpSupersedesPortInfo(StpBridgePort *port, const StpBpdu *bpdu);
48 
49 //C++ guard
50 #ifdef __cplusplus
51 }
52 #endif
53 
54 #endif
bool_t
int bool_t
Definition: compiler_port.h:53
port
uint16_t port
Definition: dns_common.h:267
stp.h
STP (Spanning Tree Protocol)
StpBridgeContext
#define StpBridgeContext
Definition: stp.h:36
StpBridgePort
#define StpBridgePort
Definition: stp.h:40
StpBpdu
StpBpdu
Definition: stp_bpdu.h:99
stpSupersedesPortInfo
bool_t stpSupersedesPortInfo(StpBridgePort *port, const StpBpdu *bpdu)
Check whether the protocol information supersedes that already held for a port.
Definition: stp_conditions.c:174
stpRootPort
bool_t stpRootPort(StpBridgePort *port)
Test whether a given port is the Root port for the bridge.
Definition: stp_conditions.c:112
stpDesignatedBridge
bool_t stpDesignatedBridge(StpBridgeContext *context)
Test whether the bridge is the Designated bridge for at least one LAN.
Definition: stp_conditions.c:77
stpDesignatedPort
bool_t stpDesignatedPort(StpBridgePort *port)
Test whether a given port is a Designated port.
Definition: stp_conditions.c:138
stpRootBridge
bool_t stpRootBridge(StpBridgeContext *context)
Test whether the bridge is the Root bridge.
Definition: stp_conditions.c:50