rstp_conditions.h File Reference

RSTP state machine conditions. More...

#include "rstp/rstp.h"

Go to the source code of this file.

Functions

uint_t rstpAdminEdge (RstpBridgePort *port)
 AdminEdge variable evaluation (17.20.1) More...
 
uint_t rstpAutoEdge (RstpBridgePort *port)
 AutoEdge variable evaluation (17.20.2) More...
 
bool_t rstpAllSynced (RstpBridgeContext *context)
 allSynced condition (17.20.3) More...
 
uint_t rstpEdgeDelay (RstpBridgePort *port)
 EdgeDelay variable evaluation (17.20.4) More...
 
uint_t rstpForwardDelay (RstpBridgePort *port)
 forwardDelay variable evaluation (17.20.5) More...
 
uint_t rstpFwdDelay (RstpBridgePort *port)
 FwdDelay variable evaluation (17.20.6) More...
 
uint_t rstpHelloTime (RstpBridgePort *port)
 HelloTime variable evaluation (17.20.7) More...
 
uint_t rstpMaxAge (RstpBridgePort *port)
 MaxAge variable evaluation (17.20.8) More...
 
uint_t rstpMigrateTime (RstpBridgeContext *context)
 MigrateTime variable evaluation (17.20.9) More...
 
bool_t rstpReRooted (RstpBridgePort *port)
 reRooted condition (17.20.10) More...
 
bool_t rstpVersion (RstpBridgeContext *context)
 rstpVersion condition (17.20.11) More...
 
bool_t stpVersion (RstpBridgeContext *context)
 stpVersion condition (17.20.12) More...
 
uint_t rstpTxHoldCount (RstpBridgeContext *context)
 TxHoldCount variable evaluation (17.20.13) More...
 

Detailed Description

RSTP state machine conditions.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneSTP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.4.0

Definition in file rstp_conditions.h.

Function Documentation

◆ rstpAdminEdge()

uint_t rstpAdminEdge ( RstpBridgePort port)

AdminEdge variable evaluation (17.20.1)

Parameters
[in]portPointer to the bridge port context
Returns
AdminEdgePort parameter for the port

Definition at line 49 of file rstp_conditions.c.

◆ rstpAllSynced()

bool_t rstpAllSynced ( RstpBridgeContext context)

allSynced condition (17.20.3)

Parameters
[in]contextPointer to the RSTP bridge context
Returns
Boolean

Definition at line 75 of file rstp_conditions.c.

◆ rstpAutoEdge()

uint_t rstpAutoEdge ( RstpBridgePort port)

AutoEdge variable evaluation (17.20.2)

Parameters
[in]portPointer to the bridge port context
Returns
AutoEdgePort parameter for the port

Definition at line 62 of file rstp_conditions.c.

◆ rstpEdgeDelay()

uint_t rstpEdgeDelay ( RstpBridgePort port)

EdgeDelay variable evaluation (17.20.4)

Parameters
[in]portPointer to the bridge port context
Returns
MigrateTime if operPointToPointMAC is TRUE, else MaxAge

Definition at line 127 of file rstp_conditions.c.

◆ rstpForwardDelay()

uint_t rstpForwardDelay ( RstpBridgePort port)

forwardDelay variable evaluation (17.20.5)

Parameters
[in]portPointer to the bridge port context
Returns
HelloTime if sendRSTP is TRUE, else FwdDelay

Definition at line 153 of file rstp_conditions.c.

◆ rstpFwdDelay()

uint_t rstpFwdDelay ( RstpBridgePort port)

FwdDelay variable evaluation (17.20.6)

Parameters
[in]portPointer to the bridge port context
Returns
Forward Delay component of designatedTimes

Definition at line 179 of file rstp_conditions.c.

◆ rstpHelloTime()

uint_t rstpHelloTime ( RstpBridgePort port)

HelloTime variable evaluation (17.20.7)

Parameters
[in]portPointer to the bridge port context
Returns
Hello Time component of designatedTimes

Definition at line 192 of file rstp_conditions.c.

◆ rstpMaxAge()

uint_t rstpMaxAge ( RstpBridgePort port)

MaxAge variable evaluation (17.20.8)

Parameters
[in]portPointer to the bridge port context
Returns
Max Age component of designatedTimes

Definition at line 205 of file rstp_conditions.c.

◆ rstpMigrateTime()

uint_t rstpMigrateTime ( RstpBridgeContext context)

MigrateTime variable evaluation (17.20.9)

Parameters
[in]contextPointer to the RSTP bridge context
Returns
Migrate Time parameter

Definition at line 218 of file rstp_conditions.c.

◆ rstpReRooted()

bool_t rstpReRooted ( RstpBridgePort port)

reRooted condition (17.20.10)

Parameters
[in]portPointer to the bridge port context
Returns
Boolean

Definition at line 231 of file rstp_conditions.c.

◆ rstpTxHoldCount()

uint_t rstpTxHoldCount ( RstpBridgeContext context)

TxHoldCount variable evaluation (17.20.13)

Parameters
[in]contextPointer to the RSTP bridge context
Returns
Transmit Hold Count parameter

Definition at line 305 of file rstp_conditions.c.

◆ rstpVersion()

bool_t rstpVersion ( RstpBridgeContext context)

rstpVersion condition (17.20.11)

Parameters
[in]contextPointer to the RSTP bridge context
Returns
Boolean

Definition at line 265 of file rstp_conditions.c.

◆ stpVersion()

bool_t stpVersion ( RstpBridgeContext context)

stpVersion condition (17.20.12)

Parameters
[in]contextPointer to the RSTP bridge context
Returns
Boolean

Definition at line 292 of file rstp_conditions.c.