Profishark API
2.3.12.0
|
Manage device features. More...
Data Structures | |
struct | ProfisharkAPIDeviceFeatures |
Profishark device features. More... | |
struct | ProfisharkAPIDevicePortSpeed |
Profishark port speed. More... | |
struct | ProfisharkAPIDevicePortsSpeed |
Profishark ports speed. More... | |
Enumerations | |
enum | ProfisharkAPITimestampMoment { ProfisharkAPITimestampMoment_Capture, ProfisharkAPITimestampMoment_Ingress, ProfisharkAPITimestampMoment_Egress } |
Defines when the timestamp information is added to the packet. More... | |
Manage device features.
Defines when the timestamp information is added to the packet.
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceFeatures | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDeviceFeatures & | features | ||
) |
Get device features.
handle | a handle to the device | |
[out] | features | a ProfisharkAPIDeviceFeatures that will be filled by the information from the driver |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDevicePortsSpeed | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDevicePortsSpeed & | speed | ||
) |
Get network ports supported speeds.
handle | a handle to the device |
speed | a ProfisharkAPIDevicePortsSpeed that will be filled with supported speeds |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetHwFirmwaresDesc | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDeviceHWFirmwaresDesc & | desc | ||
) |
Get the name corresponding to a HW firmware id.
handle | a handle to the device |
desc | a ProfisharkAPIDeviceHWFirmwareDesc that will hold firmware descriptions |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRestartDevice | ( | ProfisharkApiDeviceHandle | handle | ) |
Restart the device.
handle | a handle to the device |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISaveDeviceFeatures | ( | ProfisharkApiDeviceHandle | handle | ) |
Save device features and ports speed to EEPROM.
handle | a handle to the device |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDeviceFeatures | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDeviceFeatures | features | ||
) |
Set device features.
handle | a handle to the device |
features | a ProfisharkAPIDeviceFeatures containing features to set |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
ProfisharkAPIRet_InvalidFirmware | if the selected HW firmware id is not valid |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDevicePortsSpeed | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDevicePortsSpeed | speed | ||
) |
Set network ports supported speeds.
handle | a handle to the device |
speed | a ProfisharkAPIDevicePortsSpeed describing the supported speeds |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |