stp_operation.h
Go to the documentation of this file.
1 /**
2  * @file stp_operation.h
3  * @brief Operation of the protocol
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_OPERATION_H
32 #define _STP_OPERATION_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
44 void stpReceivedTcnBpdu(StpBridgePort *port, const StpBpdu *bpdu);
48 void stpTcnTimerExpiry(StpBridgeContext *context);
51 
52 //C++ guard
53 #ifdef __cplusplus
54 }
55 #endif
56 
57 #endif
uint16_t port
Definition: dns_common.h:267
STP (Spanning Tree Protocol)
#define StpBridgeContext
Definition: stp.h:36
#define StpBridgePort
Definition: stp.h:40
StpBpdu
Definition: stp_bpdu.h:99
void stpMessageAgeTimerExpiry(StpBridgePort *port)
Message Age Timer expiry (8.7.4)
void stpReceivedTcnBpdu(StpBridgePort *port, const StpBpdu *bpdu)
Received Topology Change Notification BPDU (8.7.2)
void stpTcnTimerExpiry(StpBridgeContext *context)
Topology Change Notification Timer expiry (8.7.6)
void stpHelloTimerExpiry(StpBridgeContext *context)
Hello Timer expiry (8.7.3)
void stpTopologyChangeTimerExpiry(StpBridgeContext *context)
Topology Change Timer expiry (8.7.7)
void stpReceivedConfigBpdu(StpBridgePort *port, const StpBpdu *bpdu)
Received Configuration BPDU (8.7.1)
Definition: stp_operation.c:52
void stpForwardDelayTimerExpiry(StpBridgePort *port)
Forward Delay Timer expiry (8.7.5)
void stpHoldTimerExpiry(StpBridgePort *port)
Hold Timer expiry (8.7.8)