stp_procedures.h File Reference

Elements of procedures. More...

#include "stp/stp.h"

Go to the source code of this file.

Functions

void stpInitProc (StpBridgeContext *context)
 Initialization procedure. More...
 
void stpTransmitConfigBpdu (StpBridgePort *port)
 Transmit Configuration BPDU (8.6.1) More...
 
void stpRecordConfigInfo (StpBridgePort *port, const StpBpdu *bpdu)
 Record configuration information (8.6.2) More...
 
void stpRecordConfigTimeoutValues (StpBridgeContext *context, const StpBpdu *bpdu)
 Record configuration timeout values (8.6.3) More...
 
void stpConfigBpduGeneration (StpBridgeContext *context)
 Configuration BPDU generation (8.6.4) More...
 
void stpReplyToConfigBpdu (StpBridgePort *port)
 Reply to Configuration BPDU (8.6.5) More...
 
void stpTransmitTcnBpdu (StpBridgeContext *context)
 Transmit Topology Change Notification BPDU (8.6.6) More...
 
void stpConfigUpdate (StpBridgeContext *context)
 Configuration update (8.6.7) More...
 
void stpRootSelection (StpBridgeContext *context)
 Root selection (8.6.8) More...
 
void stpDesignatedPortSelection (StpBridgeContext *context)
 Designated port selection (8.6.9) More...
 
void stpBecomeDesignatedPort (StpBridgePort *port)
 Become Designated port (8.6.10) More...
 
void stpPortStateSelection (StpBridgeContext *context)
 Port state selection (8.6.11) More...
 
void stpMakeForwarding (StpBridgePort *port)
 Make forwarding (8.6.12) More...
 
void stpMakeBlocking (StpBridgePort *port)
 Make blocking (8.6.13) More...
 
void stpTopologyChangeDetection (StpBridgeContext *context)
 Topology change detection (8.6.14) More...
 
void stpTopologyChangeAcked (StpBridgeContext *context)
 Topology change acknowledged (8.6.15) More...
 
void stpAckTopologyChange (StpBridgePort *port)
 Acknowledge topology change (8.6.16) More...
 

Detailed Description

Elements of procedures.

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.4

Definition in file stp_procedures.h.

Function Documentation

◆ stpAckTopologyChange()

void stpAckTopologyChange ( StpBridgePort port)

Acknowledge topology change (8.6.16)

Parameters
[in]portPointer to the bridge port context

Definition at line 749 of file stp_procedures.c.

◆ stpBecomeDesignatedPort()

void stpBecomeDesignatedPort ( StpBridgePort port)

Become Designated port (8.6.10)

Parameters
[in]portPointer to the bridge port context

Definition at line 575 of file stp_procedures.c.

◆ stpConfigBpduGeneration()

void stpConfigBpduGeneration ( StpBridgeContext context)

Configuration BPDU generation (8.6.4)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 305 of file stp_procedures.c.

◆ stpConfigUpdate()

void stpConfigUpdate ( StpBridgeContext context)

Configuration update (8.6.7)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 379 of file stp_procedures.c.

◆ stpDesignatedPortSelection()

void stpDesignatedPortSelection ( StpBridgeContext context)

Designated port selection (8.6.9)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 512 of file stp_procedures.c.

◆ stpInitProc()

void stpInitProc ( StpBridgeContext context)

Initialization procedure.

Parameters
[in]contextPointer to the STP bridge context

Definition at line 51 of file stp_procedures.c.

◆ stpMakeBlocking()

void stpMakeBlocking ( StpBridgePort port)

Make blocking (8.6.13)

Parameters
[in]portPointer to the bridge port context

Definition at line 672 of file stp_procedures.c.

◆ stpMakeForwarding()

void stpMakeForwarding ( StpBridgePort port)

Make forwarding (8.6.12)

Parameters
[in]portPointer to the bridge port context

Definition at line 654 of file stp_procedures.c.

◆ stpPortStateSelection()

void stpPortStateSelection ( StpBridgeContext context)

Port state selection (8.6.11)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 605 of file stp_procedures.c.

◆ stpRecordConfigInfo()

void stpRecordConfigInfo ( StpBridgePort port,
const StpBpdu bpdu 
)

Record configuration information (8.6.2)

Parameters
[in]portPointer to the bridge port context
[in]bpduPointer to the received Configuration BPDU

Definition at line 252 of file stp_procedures.c.

◆ stpRecordConfigTimeoutValues()

void stpRecordConfigTimeoutValues ( StpBridgeContext context,
const StpBpdu bpdu 
)

Record configuration timeout values (8.6.3)

Parameters
[in]contextPointer to the STP bridge context
[in]bpduPointer to the received Configuration BPDU

Definition at line 277 of file stp_procedures.c.

◆ stpReplyToConfigBpdu()

void stpReplyToConfigBpdu ( StpBridgePort port)

Reply to Configuration BPDU (8.6.5)

Parameters
[in]portPointer to the bridge port context

Definition at line 338 of file stp_procedures.c.

◆ stpRootSelection()

void stpRootSelection ( StpBridgeContext context)

Root selection (8.6.8)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 397 of file stp_procedures.c.

◆ stpTopologyChangeAcked()

void stpTopologyChangeAcked ( StpBridgeContext context)

Topology change acknowledged (8.6.15)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 735 of file stp_procedures.c.

◆ stpTopologyChangeDetection()

void stpTopologyChangeDetection ( StpBridgeContext context)

Topology change detection (8.6.14)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 703 of file stp_procedures.c.

◆ stpTransmitConfigBpdu()

void stpTransmitConfigBpdu ( StpBridgePort port)

Transmit Configuration BPDU (8.6.1)

Parameters
[in]portPointer to the bridge port context

Definition at line 135 of file stp_procedures.c.

◆ stpTransmitTcnBpdu()

void stpTransmitTcnBpdu ( StpBridgeContext context)

Transmit Topology Change Notification BPDU (8.6.6)

Parameters
[in]contextPointer to the STP bridge context

Definition at line 351 of file stp_procedures.c.