Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Enumerations | |
enum | OPEN_CABLE_STATUS_t { OPEN_CABLE_STATUS_UNTESTED = 0, OPEN_CABLE_STATUS_TEST_FAIL = 1, OPEN_CABLE_STATUS_NORMAL = 2, OPEN_CABLE_STATUS_OPEN = 3, OPEN_CABLE_STATUS_SHORT = 4, OPEN_CABLE_STATUS_OPENSHORT = 5, OPEN_CABLE_STATUS_CROSSTALK = 6, OPEN_CABLE_STATUS_NOCABLE = 7 } |
Functions | |
open_error_t | openapiCableStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CABLE_STATUS_t *cableStatus, uint32_t *lengthKnown, uint32_t *shortestLength, uint32_t *longestLength, uint32_t *cableFailureLength) |
Test the status of the cable attached to a given interface and report result. More... | |
enum OPEN_CABLE_STATUS_t |
Definition at line 43 of file openapi_cable_status.h.
open_error_t openapiCableStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_CABLE_STATUS_t * | cableStatus, | ||
uint32_t * | lengthKnown, | ||
uint32_t * | shortestLength, | ||
uint32_t * | longestLength, | ||
uint32_t * | cableFailureLength | ||
) |
Test the status of the cable attached to a given interface and report result.
All length parameters expressed in meters.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface number |
[out] | cableStatus | cable status detected |
[out] | lengthKnown | if 0, cable length could not be determined, otherwise length data is valid |
[out] | shortestLength | cable length range shorter limit |
[out] | longestLength | cable length range longer limit |
[out] | cableFailureLength | distance along cable to detected fault |
OPEN_E_NONE | Test completed successfully |
OPEN_E_ERROR | The cable is not of the proper type for the test or the interface does not exist |
OPEN_E_FAIL | Failed to complete the cable test |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_INTERNAL | Other internal error |
OpEN API Version: 1.14