|
Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.9.0.2
|
Data Structures | |
| struct | OPEN_DOT1AS_CLOCK_IDENTITY_t |
Macros | |
| #define | OPEN_DOT1AS_CLOCK_ID_LEN 8 |
| Length of clock identify - 8 octets. | |
| #define | OPEN_DOT1AS_MAX_ALLOWED_RESP_LOST 65535 |
| 802.1AS transmit interval limits in millisec and log base 2. | |
| #define | OPEN_DOT1AS_MAX_PDELAY_THRESHOLD 1000000000 |
| nanoseconds | |
| #define | OPEN_DOT1AS_MAX_PDU_RX_TIMEOUT 255 |
| Clock Identity. | |
| #define | OPEN_DOT1AS_MAX_PRIORITY_VALUE 255 |
| 802.1AS propagation delay threshold valid range in nanoseconds | |
| #define | OPEN_DOT1AS_MIN_ALLOWED_RESP_LOST 0 |
| #define | OPEN_DOT1AS_MIN_PDELAY_THRESHOLD 0 |
| nanoseconds | |
| #define | OPEN_DOT1AS_MIN_PDU_RX_TIMEOUT 2 |
| #define | OPEN_DOT1AS_MIN_PRIORITY_VALUE 0 |
| < Clock priority range | |
| #define | OPEN_DOT1AS_PDU_TX_INTL_LOG2_MAX 5 |
| 127 as per standard | |
| #define | OPEN_DOT1AS_PDU_TX_INTL_LOG2_MIN -5 |
| -128 as per standard | |
Enumerations | |
| enum | OPEN_DOT1AS_CLOCK_PRIORITY_t { OPEN_DOT1AS_CLOCK_PRIORITY1 = 0, OPEN_DOT1AS_CLOCK_PRIORITY2 } |
| enum | OPEN_DOT1AS_COUNTER_TYPE_t { OPEN_DOT1AS_SYNC_TX_COUNT = 1, OPEN_DOT1AS_SYNC_RX_COUNT, OPEN_DOT1AS_FOLLOWUP_TX_COUNT, OPEN_DOT1AS_FOLLOWUP_RX_COUNT, OPEN_DOT1AS_ANNOUNCE_TX_COUNT, OPEN_DOT1AS_ANNOUNCE_RX_COUNT, OPEN_DOT1AS_PDELAY_REQ_TX_COUNT, OPEN_DOT1AS_PDELAY_REQ_RX_COUNT, OPEN_DOT1AS_PDELAY_RESP_TX_COUNT, OPEN_DOT1AS_PDELAY_RESP_RX_COUNT, OPEN_DOT1AS_PDELAY_RESP_FOLLOWUP_TX_COUNT, OPEN_DOT1AS_PDELAY_RESP_FOLLOWUP_RX_COUNT, OPEN_DOT1AS_SIGNALING_TX_COUNT, OPEN_DOT1AS_SIGNALING_RX_COUNT, OPEN_DOT1AS_SYNC_RX_TIMEOUTS, OPEN_DOT1AS_SYNC_RX_DISCARDS, OPEN_DOT1AS_ANNOUNCE_RX_TIMEOUTS, OPEN_DOT1AS_ANNOUNCE_RX_DISCARDS, OPEN_DOT1AS_PDELAY_RX_TIMEOUTS, OPEN_DOT1AS_PDELAY_RX_DISCARDS, OPEN_DOT1AS_BAD_HEADER_COUNT, OPEN_DOT1AS_PTP_DISCARD_COUNT, OPEN_DOT1AS_PDELAY_LOST_RESP_EXCEEDED, OPEN_DOT1AS_COUNTER_LAST } |
| enum | OPEN_DOT1AS_GM_EVENT_TYPE_t { OPEN_DOT1AS_GM_CHANGE_EVENT, OPEN_DOT1AS_GM_PHASE_CHANGE_EVENT, OPEN_DOT1AS_GM_FREQ_CHANGE_EVENT } |
| enum | OPEN_DOT1AS_INTF_INTERVAL_t { OPEN_DOT1AS_INITIAL_SYNC_TX_INTERVAL = 0, OPEN_DOT1AS_CURRENT_SYNC_TX_INTERVAL, OPEN_DOT1AS_INITIAL_ANNOUNCE_TX_INTERVAL, OPEN_DOT1AS_CURRENT_ANNOUNCE_TX_INTERVAL, OPEN_DOT1AS_INITIAL_PDELAY_TX_INTERVAL, OPEN_DOT1AS_CURRENT_PDELAY_TX_INTERVAL, OPEN_DOT1AS_SYNC_RX_TIMEOUT, OPEN_DOT1AS_ANNOUNCE_RX_TIMEOUT, OPEN_DOT1AS_PDELAY_RX_TIMEOUT, OPEN_DOT1AS_SYNC_RX_TIMEOUT_INTERVAL } |
| enum | OPEN_DOT1AS_PORT_ROLE_t { OPEN_DOT1AS_ROLE_DISABLED = 0, OPEN_DOT1AS_ROLE_MASTER, OPEN_DOT1AS_ROLE_SLAVE, OPEN_DOT1AS_ROLE_PASSIVE } |
Functions | |
| open_error_t | openapiDot1asBestClkIdGet (openapiClientHandle_t *client_handle, OPEN_DOT1AS_CLOCK_IDENTITY_t *bestClockId) |
| Get the Best clock identity as detected by this 801AS protocol. | |
| open_error_t | openapiDot1asBestClkPriorityGet (openapiClientHandle_t *client_handle, OPEN_DOT1AS_CLOCK_PRIORITY_t clockPriorityType, uint8_t *clockPriority) |
| Get the priority 1/2 value of Best clock in the 802.1AS domain. | |
| open_error_t | openapiDot1asBestClkStepsGet (openapiClientHandle_t *client_handle, uint16_t *bestClkSteps) |
| Get the steps to Best clock as detected by this protocol. | |
| open_error_t | openapiDot1asBridgeClkIdGet (openapiClientHandle_t *client_handle, OPEN_DOT1AS_CLOCK_IDENTITY_t *bridgeClkId) |
| Get the clock identity of this bridge. | |
| open_error_t | openapiDot1asBridgePriorityGet (openapiClientHandle_t *client_handle, OPEN_DOT1AS_CLOCK_PRIORITY_t clockPriorityType, uint32_t *clockPriority) |
| Get the priority1/2 value of the local clock. | |
| open_error_t | openapiDot1asBridgePrioritySet (openapiClientHandle_t *client_handle, OPEN_DOT1AS_CLOCK_PRIORITY_t clockPriorityType, uint32_t clockPriority) |
| Set the priority1/2 value of the local clock. | |
| open_error_t | openapiDot1asEventTimestampGet (openapiClientHandle_t *client_handle, OPEN_DOT1AS_GM_EVENT_TYPE_t gmEventType, uint32_t *timeStamp) |
| Get the timestamp of the given event. | |
| open_error_t | openapiDot1asGrandmasterCapableGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *grandmasterCapable) |
| Check if this bridge is capable of being a grandmaster. | |
| open_error_t | openapiDot1asGrandmasterChangeCountGet (openapiClientHandle_t *client_handle, uint32_t *gmChangeCount) |
| Get the number of times the grandmaster has changed. | |
| open_error_t | openapiDot1asIntfAllowedLostRespGet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint32_t *numAllowedLostResp) |
| Get the number of Pdelay_Req messages for which a valid response is not received, on which a port is considered to not be exchanging peer delay messages with its neighbor. | |
| open_error_t | openapiDot1asIntfAllowedLostRespSet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint32_t numAllowedLostResp) |
| Set the number of Pdelay_Req messages for which a valid response is not received, on which a port is considered to not be exchanging peer delay messages with its neighbor. | |
| open_error_t | openapiDot1asIntfIntervalGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_DOT1AS_INTF_INTERVAL_t intervalType, int32_t *interval) |
| Get the given interval on the given interface. | |
| open_error_t | openapiDot1asIntfIntervalSet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_DOT1AS_INTF_INTERVAL_t intervalType, int32_t interval) |
| Set the given interval on the given interface. | |
| open_error_t | openapiDot1asIntfIsCapableGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_BOOL_t *isCapable) |
| Check if the given interface 802.1AS capable (as determined by the peer delay mechanism. | |
| open_error_t | openapiDot1asIntfIsMeasuringPdelayGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_BOOL_t *isMeasuringPdelay) |
| This "measuring peer delay" property, which is set to TRUE if the given interface is receiving PDELAY response messages from other end of the link. | |
| open_error_t | openapiDot1asIntfModeGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_CONTROL_t *adminMode) |
| Get the 802.1AS admin mode for the given interface. | |
| open_error_t | openapiDot1asIntfModeSet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_CONTROL_t adminMode) |
| Set the 802.1AS admin mode for the given interface. | |
| open_error_t | openapiDot1asIntfNeighborRateRatioGet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint32_t *rateRatio) |
| Get the neighbor rate ratio on the given interface (as computed by the pdelay mechanism) (extensible version). | |
| open_error_t | openapiDot1asIntfPdelayGet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint32_t *pDelay) |
| Get the propagation delay on the given interface. | |
| open_error_t | openapiDot1asIntfPdelayThresholdGet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint32_t *threshold) |
| Get the propagation delay threshold on the given interface. | |
| open_error_t | openapiDot1asIntfPdelayThresholdSet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint32_t threshold) |
| Set the propagation delay threshold on the given interface. | |
| open_error_t | openapiDot1asIntfRoleGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_DOT1AS_PORT_ROLE_t *intfRole) |
| Get the 802.1AS role of the given interface. | |
| open_error_t | openapiDot1asIntfStatsGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_DOT1AS_COUNTER_TYPE_t CounterType, uint32_t *counterValue) |
| Get the requested 802.1AS counter for the given interface. | |
| open_error_t | openapiDot1asIntfStatsReset (openapiClientHandle_t *client_handle, uint32_t intfNum) |
| Reset 802.1AS counters for the given interface. | |
| open_error_t | openapiDot1asIsGrandmasterPresentGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *grandmasterPresent) |
| Check if there is a Grand Master elected in the 802.1AS domain. | |
| open_error_t | openapiDot1asModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode) |
| Get the 802.1AS global admin mode. | |
| open_error_t | openapiDot1asModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode) |
| Set the 802.1AS global admin mode. | |
| #define OPEN_DOT1AS_MAX_ALLOWED_RESP_LOST 65535 |
802.1AS transmit interval limits in millisec and log base 2.
Interval is specified in logarithm base 2 format. Note: Although standard supports a large range of values, only a subset of values are supported.
Definition at line 53 of file openapi_dot1as.h.
| #define OPEN_DOT1AS_MAX_PDELAY_THRESHOLD 1000000000 |
nanoseconds
Minimum and maximum limits for number of PDELAY lost responses allowed
Definition at line 49 of file openapi_dot1as.h.
| #define OPEN_DOT1AS_PDU_TX_INTL_LOG2_MIN -5 |
-128 as per standard
802.1AS receipt timeout limits in number of intervals
Definition at line 61 of file openapi_dot1as.h.
Definition at line 75 of file openapi_dot1as.h.
| OPEN_DOT1AS_ROLE_DISABLED |
Disabled. |
| OPEN_DOT1AS_ROLE_MASTER |
Master. |
| OPEN_DOT1AS_ROLE_SLAVE |
Slave. |
| OPEN_DOT1AS_ROLE_PASSIVE |
Passive. |
Definition at line 82 of file openapi_dot1as.h.
| open_error_t openapiDot1asBestClkIdGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_DOT1AS_CLOCK_IDENTITY_t * | bestClockId | ||
| ) |
Get the Best clock identity as detected by this 801AS protocol.
| [in] | client_handle | client handle from registration API |
| [out] | bestClockId | Best clock id as detected by 801AS protocol. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asBestClkPriorityGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_DOT1AS_CLOCK_PRIORITY_t | clockPriorityType, | ||
| uint8_t * | clockPriority | ||
| ) |
Get the priority 1/2 value of Best clock in the 802.1AS domain.
| [in] | client_handle | client handle from registration API |
| [in] | clockPriorityType | Type of clock prority requested, Priority 1 or Priority2. |
| [out] | clockPriority | Clock priority of type clockPriorityType. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asBestClkStepsGet | ( | openapiClientHandle_t * | client_handle, |
| uint16_t * | bestClkSteps | ||
| ) |
Get the steps to Best clock as detected by this protocol.
| [in] | client_handle | client handle from registration API |
| [out] | bestClkSteps | Number of steps to the best clock. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asBridgeClkIdGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_DOT1AS_CLOCK_IDENTITY_t * | bridgeClkId | ||
| ) |
Get the clock identity of this bridge.
| [in] | client_handle | client handle from registration API |
| [out] | bridgeClkId | Clock identity of this bridge. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asBridgePriorityGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_DOT1AS_CLOCK_PRIORITY_t | clockPriorityType, | ||
| uint32_t * | clockPriority | ||
| ) |
Get the priority1/2 value of the local clock.
| [in] | client_handle | client handle from registration API |
| [in] | clockPriorityType | Type of clock prority requested, Priority 1 or Priority2. |
| [out] | clockPriority | Clock priority of value. (0 - 255) |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asBridgePrioritySet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_DOT1AS_CLOCK_PRIORITY_t | clockPriorityType, | ||
| uint32_t | clockPriority | ||
| ) |
Set the priority1/2 value of the local clock.
| [in] | client_handle | client handle from registration API |
| [in] | clockPriorityType | Type of clock prority to be set, Priority 1 or Priority2. |
| [in] | clockPriority | Clock priority value. (0-255) |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asEventTimestampGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_DOT1AS_GM_EVENT_TYPE_t | gmEventType, | ||
| uint32_t * | timeStamp | ||
| ) |
Get the timestamp of the given event.
| [in] | client_handle | client handle from registration API |
| [in] | gmEventType | Event type like GM change, phase change, freq change. |
| [out] | timeStamp | System time when the last requested event occured. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asGrandmasterCapableGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_BOOL_t * | grandmasterCapable | ||
| ) |
Check if this bridge is capable of being a grandmaster.
| [in] | client_handle | client handle from registration API |
| [out] | grandmasterCapable | Grand master capability status. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asGrandmasterChangeCountGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t * | gmChangeCount | ||
| ) |
Get the number of times the grandmaster has changed.
| [in] | client_handle | client handle from registration API |
| [out] | gmChangeCount | count of, the number of times grand master has changed. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfAllowedLostRespGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| uint32_t * | numAllowedLostResp | ||
| ) |
Get the number of Pdelay_Req messages for which a valid response is not received, on which a port is considered to not be exchanging peer delay messages with its neighbor.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | numAllowedLostResp | Number of allowed lost responses. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfAllowedLostRespSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| uint32_t | numAllowedLostResp | ||
| ) |
Set the number of Pdelay_Req messages for which a valid response is not received, on which a port is considered to not be exchanging peer delay messages with its neighbor.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [in] | numAllowedLostResp | Number of allowed lost responses. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfIntervalGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_DOT1AS_INTF_INTERVAL_t | intervalType, | ||
| int32_t * | interval | ||
| ) |
Get the given interval on the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [in] | intervalType | DOT1AS interval type. |
| [out] | interval | The interface interval/timeout value. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfIntervalSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_DOT1AS_INTF_INTERVAL_t | intervalType, | ||
| int32_t | interval | ||
| ) |
Set the given interval on the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [in] | intervalType | DOT1AS interval type. |
| [in] | interval | The interface interval/timeout value. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfIsCapableGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_BOOL_t * | isCapable | ||
| ) |
Check if the given interface 802.1AS capable (as determined by the peer delay mechanism.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | isCapable | 802.1as capability of interface. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfIsMeasuringPdelayGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_BOOL_t * | isMeasuringPdelay | ||
| ) |
This "measuring peer delay" property, which is set to TRUE if the given interface is receiving PDELAY response messages from other end of the link.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | isMeasuringPdelay | Peer delay measuring status. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfModeGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_CONTROL_t * | adminMode | ||
| ) |
Get the 802.1AS admin mode for the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | adminMode | Interface 802.1as admin mode. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfModeSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_CONTROL_t | adminMode | ||
| ) |
Set the 802.1AS admin mode for the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | adminMode | Interface 802.1as admin mode. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfNeighborRateRatioGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| uint32_t * | rateRatio | ||
| ) |
Get the neighbor rate ratio on the given interface (as computed by the pdelay mechanism) (extensible version).
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | rateRatio | The current value of the rate ratio. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfPdelayGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| uint32_t * | pDelay | ||
| ) |
Get the propagation delay on the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | pDelay | Propogation delay on the interface. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfPdelayThresholdGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| uint32_t * | threshold | ||
| ) |
Get the propagation delay threshold on the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | threshold | Propogation delay threshold on the interface. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfPdelayThresholdSet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| uint32_t | threshold | ||
| ) |
Set the propagation delay threshold on the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [in] | threshold | Propogation delay threshold on the interface. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfRoleGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_DOT1AS_PORT_ROLE_t * | intfRole | ||
| ) |
Get the 802.1AS role of the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [out] | intfRole | Interface role in the 802.1AS protocol. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfStatsGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum, | ||
| OPEN_DOT1AS_COUNTER_TYPE_t | CounterType, | ||
| uint32_t * | counterValue | ||
| ) |
Get the requested 802.1AS counter for the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| [in] | CounterType | DOT1AS counter type. |
| [out] | counterValue | Counter value. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIntfStatsReset | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | intfNum | ||
| ) |
Reset 802.1AS counters for the given interface.
| [in] | client_handle | client handle from registration API |
| [in] | intfNum | Interface number. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asIsGrandmasterPresentGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_BOOL_t * | grandmasterPresent | ||
| ) |
Check if there is a Grand Master elected in the 802.1AS domain.
| [in] | client_handle | client handle from registration API |
| [out] | grandmasterPresent | Grand master present status. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asModeGet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_CONTROL_t * | adminMode | ||
| ) |
Get the 802.1AS global admin mode.
| [in] | client_handle | client handle from registration API |
| [out] | adminMode | Global 802.1as admin mode. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20
| open_error_t openapiDot1asModeSet | ( | openapiClientHandle_t * | client_handle, |
| OPEN_CONTROL_t | adminMode | ||
| ) |
Set the 802.1AS global admin mode.
| [in] | client_handle | client handle from registration API |
| [in] | adminMode | Global 802.1as admin mode. |
| OPEN_E_NONE | On success. |
| OPEN_E_FAIL | On failure. |
| OPEN_E_PARAM | Invalid argument. |
| OPEN_E_UNAVAIL | DOT1AS feature is not supported |
OpEN API Version: 1.20