rstp_mgmt.h File Reference

Management of the RSTP bridge. More...

#include "rstp/rstp.h"

Go to the source code of this file.

Functions

error_t rstpMgmtSetVersion (RstpBridgeContext *context, uint_t value, bool_t commit)
 Set protocol version. More...
 
error_t rstpMgmtSetBridgePriority (RstpBridgeContext *context, uint16_t value, bool_t commit)
 Set bridge priority. More...
 
error_t rstpMgmtSetBridgeMaxAge (RstpBridgeContext *context, uint_t value, bool_t commit)
 Set Bridge Max Age parameter. More...
 
error_t rstpMgmtSetBridgeHelloTime (RstpBridgeContext *context, uint_t value, bool_t commit)
 Set Bridge Hello Time parameter. More...
 
error_t rstpMgmtSetBridgeForwardDelay (RstpBridgeContext *context, uint_t value, bool_t commit)
 Set Bridge Forward Delay parameter. More...
 
error_t rstpMgmtSetTxHoldCount (RstpBridgeContext *context, uint_t value, bool_t commit)
 Set Transmit Hold Count parameter. More...
 
error_t rstpMgmtSetAgeingTime (RstpBridgeContext *context, uint_t value, bool_t commit)
 Set Ageing Time parameter. More...
 
error_t rstpMgmtGetNumPorts (RstpBridgeContext *context, uint_t *value)
 Get the number of ports. More...
 
error_t rstpMgmtGetVersion (RstpBridgeContext *context, uint_t *value)
 Get assigned protocol version. More...
 
error_t rstpMgmtGetBridgeAddr (RstpBridgeContext *context, MacAddr *value)
 Get the MAC address assigned to the bridge. More...
 
error_t rstpMgmtGetBridgePriority (RstpBridgeContext *context, uint16_t *value)
 Get the assigned bridge priority. More...
 
error_t rstpMgmtGetBridgeMaxAge (RstpBridgeContext *context, uint_t *value)
 Get the assigned value of the Bridge Max Age parameter. More...
 
error_t rstpMgmtGetBridgeHelloTime (RstpBridgeContext *context, uint_t *value)
 Get the assigned value of the Bridge Hello Time parameter. More...
 
error_t rstpMgmtGetBridgeForwardDelay (RstpBridgeContext *context, uint_t *value)
 Get the assigned value of the Bridge Forward Delay parameter. More...
 
error_t rstpMgmtGetTxHoldCount (RstpBridgeContext *context, uint_t *value)
 Get the assigned value of the Transmit Hold Count parameter. More...
 
error_t rstpMgmtGetAgeingTime (RstpBridgeContext *context, uint_t *value)
 Get the assigned value of the Ageing Time parameter. More...
 
error_t rstpMgmtGetDesignatedRoot (RstpBridgeContext *context, StpBridgeId *value)
 Get the bridge identifier of the root of the spanning tree. More...
 
error_t rstpMgmtGetRootPathCost (RstpBridgeContext *context, uint32_t *value)
 Get the current cost of the path to the root. More...
 
error_t rstpMgmtGetRootPort (RstpBridgeContext *context, uint16_t *value)
 Get the current root port. More...
 
error_t rstpMgmtGetMaxAge (RstpBridgeContext *context, uint_t *value)
 Get the current Max Age value. More...
 
error_t rstpMgmtGetHelloTime (RstpBridgeContext *context, uint_t *value)
 Get the current Hello Time value. More...
 
error_t rstpMgmtGetForwardDelay (RstpBridgeContext *context, uint_t *value)
 Get the current Forward Delay value. More...
 
error_t rstpMgmtGetTopologyChanges (RstpBridgeContext *context, uint_t *value)
 Get the number of topology changes. More...
 
error_t rstpMgmtGetTimeSinceTopologyChange (RstpBridgeContext *context, uint_t *value)
 Get the time since a topology change was last detected. More...
 
error_t rstpMgmtSetPortPriority (RstpBridgeContext *context, uint_t portIndex, uint8_t value, bool_t commit)
 Set port priority. More...
 
error_t rstpMgmtSetAdminPortState (RstpBridgeContext *context, uint_t portIndex, bool_t value, bool_t commit)
 Set administrative bridge port state. More...
 
error_t rstpMgmtSetAdminPortPathCost (RstpBridgeContext *context, uint_t portIndex, uint32_t value, bool_t commit)
 Set administrative port path cost. More...
 
error_t rstpMgmtSetAdminPointToPointMac (RstpBridgeContext *context, uint_t portIndex, RstpAdminPointToPointMac value, bool_t commit)
 Set administrative point-to-point status of the LAN segment. More...
 
error_t rstpMgmtSetAdminEdgePort (RstpBridgeContext *context, uint_t portIndex, bool_t value, bool_t commit)
 Set administrative value of the Edge Port parameter. More...
 
error_t rstpMgmtSetAutoEdgePort (RstpBridgeContext *context, uint_t portIndex, bool_t value, bool_t commit)
 Set AutoEdgePort parameter. More...
 
error_t rstpMgmtSetProtocolMigration (RstpBridgeContext *context, uint_t portIndex, bool_t value, bool_t commit)
 Force protocol migration. More...
 
error_t rstpMgmtGetPortAddr (RstpBridgeContext *context, uint_t portIndex, MacAddr *value)
 Get the MAC address assigned to the port. More...
 
error_t rstpMgmtGetPortPriority (RstpBridgeContext *context, uint_t portIndex, uint8_t *value)
 Get the priority assigned to the port. More...
 
error_t rstpMgmtGetAdminPortState (RstpBridgeContext *context, uint_t portIndex, bool_t *value)
 Get the administrative port state. More...
 
error_t rstpMgmtGetMacOperState (RstpBridgeContext *context, uint_t portIndex, bool_t *value)
 Get the current MAC operational state. More...
 
error_t rstpMgmtGetAdminPortPathCost (RstpBridgeContext *context, uint_t portIndex, uint32_t *value)
 Get the administrative port path cost. More...
 
error_t rstpMgmtGetPortPathCost (RstpBridgeContext *context, uint_t portIndex, uint32_t *value)
 Get the current value of the port path cost. More...
 
error_t rstpMgmtGetAdminPointToPointMac (RstpBridgeContext *context, uint_t portIndex, RstpAdminPointToPointMac *value)
 Get the administrative point-to-point status of the LAN segment. More...
 
error_t rstpMgmtGetOperPointToPointMac (RstpBridgeContext *context, uint_t portIndex, bool_t *value)
 Get the operational point-to-point status of the LAN segment. More...
 
error_t rstpMgmtGetAdminEdgePort (RstpBridgeContext *context, uint_t portIndex, bool_t *value)
 Get the administrative value of the Edge Port parameter. More...
 
error_t rstpMgmtGetAutoEdgePort (RstpBridgeContext *context, uint_t portIndex, bool_t *value)
 Get the value of the AutoEdgePort parameter. More...
 
error_t rstpMgmtGetOperEdgePort (RstpBridgeContext *context, uint_t portIndex, bool_t *value)
 Get the operational value of the Edge Port parameter. More...
 
error_t rstpMgmtGetPortState (RstpBridgeContext *context, uint_t portIndex, StpPortState *value)
 Get the current state of the port. More...
 
error_t rstpMgmtGetPortRole (RstpBridgeContext *context, uint_t portIndex, StpPortRole *value)
 Get the assigned role of the port. More...
 
error_t rstpMgmtGetPortDesignatedRoot (RstpBridgeContext *context, uint_t portIndex, StpBridgeId *value)
 Get the bridge identifier of the designated root bridge. More...
 
error_t rstpMgmtGetPortDesignatedCost (RstpBridgeContext *context, uint_t portIndex, uint32_t *value)
 Get the designated cost of the port. More...
 
error_t rstpMgmtGetPortDesignatedBridge (RstpBridgeContext *context, uint_t portIndex, StpBridgeId *value)
 Get the bridge identifier of the designated bridge. More...
 
error_t rstpMgmtGetPortDesignatedPort (RstpBridgeContext *context, uint_t portIndex, uint16_t *value)
 Get the port identifier of the designated bridge. More...
 
error_t rstpMgmtGetForwardTransitions (RstpBridgeContext *context, uint_t portIndex, uint_t *value)
 Get the number of times the port has transitioned to Forwarding state. More...
 

Detailed Description

Management of the RSTP bridge.

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_mgmt.h.

Function Documentation

◆ rstpMgmtGetAdminEdgePort()

error_t rstpMgmtGetAdminEdgePort ( RstpBridgeContext context,
uint_t  portIndex,
bool_t value 
)

Get the administrative value of the Edge Port parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueAdministrative value of the Edge Port parameter
Returns
Error code

Definition at line 1440 of file rstp_mgmt.c.

◆ rstpMgmtGetAdminPointToPointMac()

error_t rstpMgmtGetAdminPointToPointMac ( RstpBridgeContext context,
uint_t  portIndex,
RstpAdminPointToPointMac value 
)

Get the administrative point-to-point status of the LAN segment.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueAdministrative point-to-point status of the LAN segment attached to this port
Returns
Error code

Definition at line 1374 of file rstp_mgmt.c.

◆ rstpMgmtGetAdminPortPathCost()

error_t rstpMgmtGetAdminPortPathCost ( RstpBridgeContext context,
uint_t  portIndex,
uint32_t *  value 
)

Get the administrative port path cost.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueAdministrative port path cost
Returns
Error code

Definition at line 1308 of file rstp_mgmt.c.

◆ rstpMgmtGetAdminPortState()

error_t rstpMgmtGetAdminPortState ( RstpBridgeContext context,
uint_t  portIndex,
bool_t value 
)

Get the administrative port state.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueAdministrative port state
Returns
Error code

Definition at line 1244 of file rstp_mgmt.c.

◆ rstpMgmtGetAgeingTime()

error_t rstpMgmtGetAgeingTime ( RstpBridgeContext context,
uint_t value 
)

Get the assigned value of the Ageing Time parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueValue of the Ageing Time parameter
Returns
Error code

Definition at line 604 of file rstp_mgmt.c.

◆ rstpMgmtGetAutoEdgePort()

error_t rstpMgmtGetAutoEdgePort ( RstpBridgeContext context,
uint_t  portIndex,
bool_t value 
)

Get the value of the AutoEdgePort parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueValue of the AutoEdgePort parameter for the port
Returns
Error code

Definition at line 1472 of file rstp_mgmt.c.

◆ rstpMgmtGetBridgeAddr()

error_t rstpMgmtGetBridgeAddr ( RstpBridgeContext context,
MacAddr value 
)

Get the MAC address assigned to the bridge.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueMAC address of the bridge
Returns
Error code

Definition at line 478 of file rstp_mgmt.c.

◆ rstpMgmtGetBridgeForwardDelay()

error_t rstpMgmtGetBridgeForwardDelay ( RstpBridgeContext context,
uint_t value 
)

Get the assigned value of the Bridge Forward Delay parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueValue of the Bridge Forward Delay parameter, in seconds
Returns
Error code

Definition at line 562 of file rstp_mgmt.c.

◆ rstpMgmtGetBridgeHelloTime()

error_t rstpMgmtGetBridgeHelloTime ( RstpBridgeContext context,
uint_t value 
)

Get the assigned value of the Bridge Hello Time parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueValue of the Bridge Hello Time parameter, in seconds
Returns
Error code

Definition at line 541 of file rstp_mgmt.c.

◆ rstpMgmtGetBridgeMaxAge()

error_t rstpMgmtGetBridgeMaxAge ( RstpBridgeContext context,
uint_t value 
)

Get the assigned value of the Bridge Max Age parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueValue of the Bridge Max Age parameter, in seconds
Returns
Error code

Definition at line 520 of file rstp_mgmt.c.

◆ rstpMgmtGetBridgePriority()

error_t rstpMgmtGetBridgePriority ( RstpBridgeContext context,
uint16_t *  value 
)

Get the assigned bridge priority.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueBridge priority
Returns
Error code

Definition at line 499 of file rstp_mgmt.c.

◆ rstpMgmtGetDesignatedRoot()

error_t rstpMgmtGetDesignatedRoot ( RstpBridgeContext context,
StpBridgeId value 
)

Get the bridge identifier of the root of the spanning tree.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueBridge identifier
Returns
Error code

Definition at line 625 of file rstp_mgmt.c.

◆ rstpMgmtGetForwardDelay()

error_t rstpMgmtGetForwardDelay ( RstpBridgeContext context,
uint_t value 
)

Get the current Forward Delay value.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueForward Delay value, in seconds
Returns
Error code

Definition at line 735 of file rstp_mgmt.c.

◆ rstpMgmtGetForwardTransitions()

error_t rstpMgmtGetForwardTransitions ( RstpBridgeContext context,
uint_t  portIndex,
uint_t value 
)

Get the number of times the port has transitioned to Forwarding state.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueNumber of transitions to Forwarding state
Returns
Error code

Definition at line 1789 of file rstp_mgmt.c.

◆ rstpMgmtGetHelloTime()

error_t rstpMgmtGetHelloTime ( RstpBridgeContext context,
uint_t value 
)

Get the current Hello Time value.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueHello Time value, in seconds
Returns
Error code

Definition at line 712 of file rstp_mgmt.c.

◆ rstpMgmtGetMacOperState()

error_t rstpMgmtGetMacOperState ( RstpBridgeContext context,
uint_t  portIndex,
bool_t value 
)

Get the current MAC operational state.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueMAC operational state
Returns
Error code

Definition at line 1276 of file rstp_mgmt.c.

◆ rstpMgmtGetMaxAge()

error_t rstpMgmtGetMaxAge ( RstpBridgeContext context,
uint_t value 
)

Get the current Max Age value.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueMax Age value, in seconds
Returns
Error code

Definition at line 690 of file rstp_mgmt.c.

◆ rstpMgmtGetNumPorts()

error_t rstpMgmtGetNumPorts ( RstpBridgeContext context,
uint_t value 
)

Get the number of ports.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueNumber of ports
Returns
Error code

Definition at line 435 of file rstp_mgmt.c.

◆ rstpMgmtGetOperEdgePort()

error_t rstpMgmtGetOperEdgePort ( RstpBridgeContext context,
uint_t  portIndex,
bool_t value 
)

Get the operational value of the Edge Port parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueOperational value of the Edge Port parameter
Returns
Error code

Definition at line 1504 of file rstp_mgmt.c.

◆ rstpMgmtGetOperPointToPointMac()

error_t rstpMgmtGetOperPointToPointMac ( RstpBridgeContext context,
uint_t  portIndex,
bool_t value 
)

Get the operational point-to-point status of the LAN segment.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueOperational point-to-point status of the LAN segment attached to this port
Returns
Error code

Definition at line 1408 of file rstp_mgmt.c.

◆ rstpMgmtGetPortAddr()

error_t rstpMgmtGetPortAddr ( RstpBridgeContext context,
uint_t  portIndex,
MacAddr value 
)

Get the MAC address assigned to the port.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueMAC address of the individual MAC entity for the port
Returns
Error code

Definition at line 1180 of file rstp_mgmt.c.

◆ rstpMgmtGetPortDesignatedBridge()

error_t rstpMgmtGetPortDesignatedBridge ( RstpBridgeContext context,
uint_t  portIndex,
StpBridgeId value 
)

Get the bridge identifier of the designated bridge.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueBridge identifier
Returns
Error code

Definition at line 1723 of file rstp_mgmt.c.

◆ rstpMgmtGetPortDesignatedCost()

error_t rstpMgmtGetPortDesignatedCost ( RstpBridgeContext context,
uint_t  portIndex,
uint32_t *  value 
)

Get the designated cost of the port.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueDesignated cost of the port
Returns
Error code

Definition at line 1690 of file rstp_mgmt.c.

◆ rstpMgmtGetPortDesignatedPort()

error_t rstpMgmtGetPortDesignatedPort ( RstpBridgeContext context,
uint_t  portIndex,
uint16_t *  value 
)

Get the port identifier of the designated bridge.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valuePort identifier
Returns
Error code

Definition at line 1756 of file rstp_mgmt.c.

◆ rstpMgmtGetPortDesignatedRoot()

error_t rstpMgmtGetPortDesignatedRoot ( RstpBridgeContext context,
uint_t  portIndex,
StpBridgeId value 
)

Get the bridge identifier of the designated root bridge.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valueBridge identifier
Returns
Error code

Definition at line 1656 of file rstp_mgmt.c.

◆ rstpMgmtGetPortPathCost()

error_t rstpMgmtGetPortPathCost ( RstpBridgeContext context,
uint_t  portIndex,
uint32_t *  value 
)

Get the current value of the port path cost.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valuePort path cost
Returns
Error code

Definition at line 1340 of file rstp_mgmt.c.

◆ rstpMgmtGetPortPriority()

error_t rstpMgmtGetPortPriority ( RstpBridgeContext context,
uint_t  portIndex,
uint8_t *  value 
)

Get the priority assigned to the port.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valuePort priority
Returns
Error code

Definition at line 1212 of file rstp_mgmt.c.

◆ rstpMgmtGetPortRole()

error_t rstpMgmtGetPortRole ( RstpBridgeContext context,
uint_t  portIndex,
StpPortRole value 
)

Get the assigned role of the port.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valuePort role
Returns
Error code

Definition at line 1624 of file rstp_mgmt.c.

◆ rstpMgmtGetPortState()

error_t rstpMgmtGetPortState ( RstpBridgeContext context,
uint_t  portIndex,
StpPortState value 
)

Get the current state of the port.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[out]valuePort state
Returns
Error code

Definition at line 1536 of file rstp_mgmt.c.

◆ rstpMgmtGetRootPathCost()

error_t rstpMgmtGetRootPathCost ( RstpBridgeContext context,
uint32_t *  value 
)

Get the current cost of the path to the root.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueRoot path cost
Returns
Error code

Definition at line 647 of file rstp_mgmt.c.

◆ rstpMgmtGetRootPort()

error_t rstpMgmtGetRootPort ( RstpBridgeContext context,
uint16_t *  value 
)

Get the current root port.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valuePort number
Returns
Error code

Definition at line 668 of file rstp_mgmt.c.

◆ rstpMgmtGetTimeSinceTopologyChange()

error_t rstpMgmtGetTimeSinceTopologyChange ( RstpBridgeContext context,
uint_t value 
)

Get the time since a topology change was last detected.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueTime since a topology change was last detected
Returns
Error code

Definition at line 778 of file rstp_mgmt.c.

◆ rstpMgmtGetTopologyChanges()

error_t rstpMgmtGetTopologyChanges ( RstpBridgeContext context,
uint_t value 
)

Get the number of topology changes.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueNumber of topology changes
Returns
Error code

Definition at line 757 of file rstp_mgmt.c.

◆ rstpMgmtGetTxHoldCount()

error_t rstpMgmtGetTxHoldCount ( RstpBridgeContext context,
uint_t value 
)

Get the assigned value of the Transmit Hold Count parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueValue of the Transmit Hold Count parameter
Returns
Error code

Definition at line 583 of file rstp_mgmt.c.

◆ rstpMgmtGetVersion()

error_t rstpMgmtGetVersion ( RstpBridgeContext context,
uint_t value 
)

Get assigned protocol version.

Parameters
[in]contextPointer to the RSTP bridge context
[out]valueProtocol version
Returns
Error code

Definition at line 456 of file rstp_mgmt.c.

◆ rstpMgmtSetAdminEdgePort()

error_t rstpMgmtSetAdminEdgePort ( RstpBridgeContext context,
uint_t  portIndex,
bool_t  value,
bool_t  commit 
)

Set administrative value of the Edge Port parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valueAdministrative value of the Edge Port parameter
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 1029 of file rstp_mgmt.c.

◆ rstpMgmtSetAdminPointToPointMac()

error_t rstpMgmtSetAdminPointToPointMac ( RstpBridgeContext context,
uint_t  portIndex,
RstpAdminPointToPointMac  value,
bool_t  commit 
)

Set administrative point-to-point status of the LAN segment.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valueAdministrative point-to-point status of the LAN segment attached to this port
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 971 of file rstp_mgmt.c.

◆ rstpMgmtSetAdminPortPathCost()

error_t rstpMgmtSetAdminPortPathCost ( RstpBridgeContext context,
uint_t  portIndex,
uint32_t  value,
bool_t  commit 
)

Set administrative port path cost.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valueAdministrative port path cost
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 910 of file rstp_mgmt.c.

◆ rstpMgmtSetAdminPortState()

error_t rstpMgmtSetAdminPortState ( RstpBridgeContext context,
uint_t  portIndex,
bool_t  value,
bool_t  commit 
)

Set administrative bridge port state.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valueAdministrative bridge port state
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 860 of file rstp_mgmt.c.

◆ rstpMgmtSetAgeingTime()

error_t rstpMgmtSetAgeingTime ( RstpBridgeContext context,
uint_t  value,
bool_t  commit 
)

Set Ageing Time parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueValue of the Ageing Time parameter
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 391 of file rstp_mgmt.c.

◆ rstpMgmtSetAutoEdgePort()

error_t rstpMgmtSetAutoEdgePort ( RstpBridgeContext context,
uint_t  portIndex,
bool_t  value,
bool_t  commit 
)

Set AutoEdgePort parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valueAutoEdgePort parameter for the port
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 1079 of file rstp_mgmt.c.

◆ rstpMgmtSetBridgeForwardDelay()

error_t rstpMgmtSetBridgeForwardDelay ( RstpBridgeContext context,
uint_t  value,
bool_t  commit 
)

Set Bridge Forward Delay parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueValue of the Bridge Forward Delay parameter, in seconds
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 276 of file rstp_mgmt.c.

◆ rstpMgmtSetBridgeHelloTime()

error_t rstpMgmtSetBridgeHelloTime ( RstpBridgeContext context,
uint_t  value,
bool_t  commit 
)

Set Bridge Hello Time parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueValue of the Bridge Hello Time parameter, in seconds
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 216 of file rstp_mgmt.c.

◆ rstpMgmtSetBridgeMaxAge()

error_t rstpMgmtSetBridgeMaxAge ( RstpBridgeContext context,
uint_t  value,
bool_t  commit 
)

Set Bridge Max Age parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueValue of the Bridge Max Age parameter, in seconds
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 156 of file rstp_mgmt.c.

◆ rstpMgmtSetBridgePriority()

error_t rstpMgmtSetBridgePriority ( RstpBridgeContext context,
uint16_t  value,
bool_t  commit 
)

Set bridge priority.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueBridge priority
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 96 of file rstp_mgmt.c.

◆ rstpMgmtSetPortPriority()

error_t rstpMgmtSetPortPriority ( RstpBridgeContext context,
uint_t  portIndex,
uint8_t  value,
bool_t  commit 
)

Set port priority.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valuePort priority
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 804 of file rstp_mgmt.c.

◆ rstpMgmtSetProtocolMigration()

error_t rstpMgmtSetProtocolMigration ( RstpBridgeContext context,
uint_t  portIndex,
bool_t  value,
bool_t  commit 
)

Force protocol migration.

Parameters
[in]contextPointer to the RSTP bridge context
[in]portIndexPort index
[in]valueValue of the mcheck parameter. Setting mcheck variable to FALSE has no effect
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 1127 of file rstp_mgmt.c.

◆ rstpMgmtSetTxHoldCount()

error_t rstpMgmtSetTxHoldCount ( RstpBridgeContext context,
uint_t  value,
bool_t  commit 
)

Set Transmit Hold Count parameter.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueValue of the Transmit Hold Count parameter
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 339 of file rstp_mgmt.c.

◆ rstpMgmtSetVersion()

error_t rstpMgmtSetVersion ( RstpBridgeContext context,
uint_t  value,
bool_t  commit 
)

Set protocol version.

Parameters
[in]contextPointer to the RSTP bridge context
[in]valueProtocol version
[in]commitIf this flag is TRUE, the bridge verifies the parameter value and commits the change if the value is valid. If FALSE, the bridge only performs the verification and does not take any further action
Returns
Error code

Definition at line 55 of file rstp_mgmt.c.