Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
openapi_bridge.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_DOT1D_BLOCKING   1
 
#define OPEN_DOT1D_DISABLED   5
 
#define OPEN_DOT1D_FORWARDING   4
 
#define OPEN_DOT1D_LEARNING   3
 
#define OPEN_DOT1D_LISTENING   2
 
#define OPEN_DOT1D_MANUAL_FWD   6
 
#define OPEN_DOT1D_NOT_PARTICIPATE   7
 
#define OPEN_FDB_ADDR_LEN   8
 
#define OPEN_FDB_ADDR_STR_LEN   ((OPEN_FDB_ADDR_LEN * 2) + (OPEN_FDB_ADDR_LEN - 1))
 
#define OPEN_NULLPTR   ((void *)0)
 
#define OPEN_STP_DOT1D_DESIGNATED_ROOT_LEN   18
 
#define OPEN_STP_PROTOCOL_SPEC_IEEE8021D   3
 
#define OPEN_STP_PROTOCOL_SPEC_UNKNOWN   1
 

Functions

open_error_t openapiDbDot1dTpAgingTimeGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get timeout period for aging out dynamically learned forwarding information. More...
 
open_error_t openapiDbDot1dTpAgingTimeSet (openapiClientHandle_t *client_handle, uint32_t value)
 Set timeout period for aging out dynamically learned forwarding information. More...
 
open_error_t openapiDot1dBaseBridgeAddressGet (openapiClientHandle_t *client_handle, open_buffdesc *bridgeAddress)
 Get the unique MAC address used to refer to the bridge. More...
 
open_error_t openapiDot1dBaseNumPortsGet (openapiClientHandle_t *client_handle, uint32_t *numPorts)
 Get number of ports controlled by the bridging entity. More...
 
open_error_t openapiDot1dBasePortCircuitGet (openapiClientHandle_t *client_handle, uint32_t port, open_buffdesc *buffer)
 Get name of an object instance unique to this port. More...
 
open_error_t openapiDot1dBasePortDelayExceededDiscardsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *delayExceededDiscardsValue)
 Get number of frames discarded by this port due to delay through the bridge. More...
 
open_error_t openapiDot1dBasePortEntryGet (openapiClientHandle_t *client_handle, uint32_t port)
 Get admin state of the port. More...
 
open_error_t openapiDot1dBasePortEntryNextGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum)
 Get Internal Interface Number of next valid port. More...
 
open_error_t openapiDot1dBasePortIfIndexGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *ifIndex)
 Get ifIndex associated with the internal interface number. More...
 
open_error_t openapiDot1dBasePortMtuExceededDiscardsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *mtuExceededDiscardsValue)
 Get number of frames discarded by this port due to delay through the bridge. More...
 
open_error_t openapiDot1dBaseTypeGet (openapiClientHandle_t *client_handle, uint32_t *type)
 Get dot1d Base type of bridging. More...
 
open_error_t openapiDot1dInstanceMemberGetNext (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum)
 Get next interface for current instance. More...
 
open_error_t openapiDot1dIsInterfaceInCurrentInstance (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *isInInstance)
 Determine if the interface is the currently configured STP instance. More...
 
open_error_t openapiDot1dIsValidIntf (openapiClientHandle_t *client_handle, uint32_t intIfNum)
 Check if an interface is valid for DOT1D. More...
 
open_error_t openapiDot1dStpBridgeForwardDelayGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree Bridge Forward Delay. More...
 
open_error_t openapiDot1dStpBridgeHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree Bridge Hello Time. More...
 
open_error_t openapiDot1dStpBridgeMaxAgeGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree bridge max age. More...
 
open_error_t openapiDot1dStpDesignatedRootGet (openapiClientHandle_t *client_handle, open_buffdesc *buffer)
 Get Spanning Tree Designated root for the switch. More...
 
open_error_t openapiDot1dStpForwardDelayGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree forward delay. More...
 
open_error_t openapiDot1dStpHelloTimeGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree hello time. More...
 
open_error_t openapiDot1dStpHoldTimeGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree hold time. More...
 
open_error_t openapiDot1dStpMaxAgeGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get Spanning Tree max age. More...
 
open_error_t openapiDot1dStpPortDesignatedBridgeGet (openapiClientHandle_t *client_handle, uint32_t port, open_buffdesc *buffer)
 Get Spanning Tree Designated Bridge for this port. More...
 
open_error_t openapiDot1dStpPortDesignatedCostGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get Spanning Tree Designated Cost for this port. More...
 
open_error_t openapiDot1dStpPortDesignatedPortGet (openapiClientHandle_t *client_handle, uint32_t port, uint16_t *value)
 Get Spanning Tree Designated port ID. More...
 
open_error_t openapiDot1dStpPortDesignatedRootGet (openapiClientHandle_t *client_handle, uint32_t port, open_buffdesc *buffer)
 Get Spanning Tree Designated Root for the switch. More...
 
open_error_t openapiDot1dStpPortForwardTransitionsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get number of times this port has transitioned from Learning state to Forwarding state. More...
 
open_error_t openapiDot1dStpPortPathCostGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get Spanning Tree Path Cost for this port. More...
 
open_error_t openapiDot1dStpPortPriorityGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get Spanning Tree Port Priority. More...
 
open_error_t openapiDot1dStpPortStateGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get Spanning Tree Port State. More...
 
open_error_t openapiDot1dStpPriorityGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get the Spanning Tree Bridge priority. More...
 
open_error_t openapiDot1dStpProtocolSpecificationGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get indication of what version of the Spanning Tree Protocol is being run. More...
 
open_error_t openapiDot1dStpRootCostGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get the cost of the path to the root as seen from this bridge. More...
 
open_error_t openapiDot1dStpRootPortGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get port number with lowest cost path from bridge to the root bridge. More...
 
open_error_t openapiDot1dStpTimeSinceTopologyChangeGet (openapiClientHandle_t *client_handle, uint64_t *value)
 Get the time since last topology change was detected by the bridge. More...
 
open_error_t openapiDot1dStpTopChangesGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get the STP change count. More...
 
open_error_t openapiDot1dTpFdbEntryGet (openapiClientHandle_t *client_handle, open_buffdesc *address)
 Get info about a specific unicast MAC address which the bridge has forwarding and/or filtering information. More...
 
open_error_t openapiDot1dTpFdbEntryNextGet (openapiClientHandle_t *client_handle, open_buffdesc *address)
 Get info about a specific unicast MAC address which the bridge has forwarding and/or filtering information. More...
 
open_error_t openapiDot1dTpFdbPortGet (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t *value)
 Returns the port number. More...
 
open_error_t openapiDot1dTpFdbStatusGet (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t *value)
 Get the status of the dot1dTpFdbEntry. More...
 
open_error_t openapiDot1dTpLearnedEntryDiscardsGet (openapiClientHandle_t *client_handle, uint32_t *value)
 Get number of Forwarding Database entries that have been discarded due to a lack of space to store them. More...
 
open_error_t openapiDot1dTpPortInDiscardsGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get count of valid frames received which were discarded by the Forwarding Process. More...
 
open_error_t openapiDot1dTpPortInFramesGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get number of frames received by this port from its segment. More...
 
open_error_t openapiDot1dTpPortMaxInfoGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get maximum size of the INFO field this port will receive or transmit. More...
 
open_error_t openapiDot1dTpPortOutFramesGet (openapiClientHandle_t *client_handle, uint32_t port, uint32_t *value)
 Get number of frames transmitted by this port to its segment. More...