Profishark API  2.3.12.0
ProfisharkAPI.h File Reference
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  ProfisharkAPIDeviceExtraInfo
 Profishark device extra information. More...
 
struct  ProfisharkAPIDeviceFeatures
 Profishark device features. More...
 
struct  ProfisharkAPIDevicePortSpeed
 Profishark port speed. More...
 
struct  ProfisharkAPIDevicePortsSpeed
 Profishark ports speed. More...
 
struct  ProfisharkApiSWVersion
 SW firmware or driver version. More...
 
struct  ProfisharkApiHWVersion
 HW firmware version. More...
 
struct  ProfisharkApiVersions
 firmwares and driver versions More...
 
struct  ProfisharkApiRJ45PortStatus
 RJ45 port link status. More...
 
struct  ProfisharkApiRJ45PortsStatus
 Describe all RJ45 ports. More...
 
struct  ProfisharkApiSFPPortStatus
 Description of a SFP module. More...
 
struct  ProfisharkApiSFPPortsStatus
 Describe all SFP ports. More...
 
struct  ProfisharkApiPHYRegisters
 A PHY registers. More...
 
struct  ProfisharkApiPHYsRegisters
 Describe all available PHYs registers. More...
 
struct  ProfisharkApiLinkStatus
 Device link status. More...
 
struct  ProfisharkApiStatisticsV1Port
 Statistics structure for a single port of a device supporting V1 model. More...
 
struct  ProfisharkApiStatisticsV1
 Statistics structure for devices supporting V1 model. More...
 
struct  ProfisharkApiStatisticsV2
 Statistics structure for devices supporting V2 model. More...
 
struct  ProfisharkApiStatistics
 Statistics structure for a Profishark device. More...
 
struct  ProfisharkApiCounterV2
 Counter V2 description. More...
 
struct  ProfisharkApiDpiFilter
 DPI filter configuration. More...
 
struct  ProfisharkApiPacketFilter
 Packet filter configuration. More...
 
struct  ProfisharkAPITimingTime
 Timing configuration. More...
 
struct  ProfisharkAPITimingDataTime
 Represents a date and time. More...
 
struct  ProfisharkAPITimingStatus
 Status of the device timing board. More...
 
struct  ProfisharkAPIDiskDumpConfig
 
struct  ProfisharkAPIDiskDumpStatus
 Direct capture status. More...
 
struct  ProfisharkAPIDeviceHWFirmwareDesc
 Descriptions of a HW firmwares. More...
 
struct  ProfisharkAPIDeviceHWFirmwaresDesc
 Descriptions of the supported HW firmwares. More...
 
struct  ProfisharkAPIMemoryCaptureConfig
 
struct  ProfisharkApiDeviceNode
 
struct  ProfisharkApiDeviceList
 
struct  ProfisharkApiCallbackValue_DiskDump
 

Macros

#define PROFISHARKAPI_STATISTICSV2_COUNTERS   16
 The maximum number of counters available in a device supporting V2 statistics model.
 
#define PROFISHARKAPI_MEMORYCAPTURE_BUFFER_LENGTH   (16384*4*8)
 Minimum length of a buffer for memory capture.
 
#define PROFISHARK_MAX_HW_NAME_LENGTH   32
 Maximum length of a HW firmware name.
 
#define PROFISHARK_MAX_HW_COUNT   4
 Maximum number of HW firmwares.
 
#define IS_PROFISHARK_API_SUCCESS(a)   (a==ProfisharkAPIRet_Success)
 Returns if the value means success. More...
 
#define PROFISHARK_API_INVALID_HANDLE   ((void*)-1)
 Invalid handle value.
 

Typedefs

typedef void * ProfisharkApiDeviceHandle
 Profishark device handle. More...
 
typedef void * ProfisharkApiCallbackValue
 Profishark callback value. More...
 
typedef void(* ProfisharkApiCallback) (ProfisharkApiDeviceHandle, void *)
 Callback function. More...
 
typedef void(* ProfisharkApiCallbackExt) (ProfisharkApiDeviceHandle, ProfisharkApiCallbackValue *, void *)
 Callback function. More...
 

Enumerations

enum  ProfisharkAPIRet {
  ProfisharkAPIRet_Success =0, ProfisharkAPIRet_Failed =-1, ProfisharkAPIRet_Exist =-2, ProfisharkAPIRet_NotExist =-3,
  ProfisharkAPIRet_NoDev =-4, ProfisharkAPIRet_Unsupported =-5, ProfisharkAPIRet_CannotCreateFile =-6, ProfisharkAPIRet_CannotAllocateCache =-7,
  ProfisharkAPIRet_CaptureNotReady =-8, ProfisharkAPIRet_CacheTooSmall =-9, ProfisharkAPIRet_TooSmall =-10, ProfisharkAPIRet_NotImplemented =-11,
  ProfisharkAPIRet_NotReady =-12, ProfisharkAPIRet_Again =-13, ProfisharkAPIRet_CannotOpenFile =-14, ProfisharkAPIRet_InvalidFirmware =-15,
  ProfisharkAPIRet_NotStarted =-16
}
 Error constants. More...
 
enum  ProfisharkAPIFlagState { ProfisharkAPIFlagState_No, ProfisharkAPIFlagState_Yes, ProfisharkAPIFlagState_Unknown }
 State of a flag. More...
 
enum  ProfisharkAPIDeviceType {
  ProfisharkAPIDeviceType_None, ProfisharkAPIDeviceType_BadDevice, ProfisharkAPIDeviceType_UnknownDevice, ProfisharkAPIDeviceType_Profishark1G,
  ProfisharkAPIDeviceType_C1GIGE_USB, ProfisharkAPIDeviceType_Profishark1GPlus, ProfisharkAPIDeviceType_Profishark1G_v5, ProfisharkAPIDeviceType_Profishark1G_v5_POE,
  ProfisharkAPIDeviceType_Profishark1GPlus_POE, ProfisharkAPIDeviceType_Profishark1GPlus_GPS, ProfisharkAPIDeviceType_Profishark1GPlus_GPS_POE, ProfisharkAPIDeviceType_Profishark10G,
  ProfisharkAPIDeviceType_Profishark10G_GPS, ProfisharkAPIDeviceType_Profishark100, ProfisharkAPIDeviceType_Profishark1G_v6
}
 Profishark devices models. More...
 
enum  ProfisharkApiDeviceOptions {
  ProfisharkApiDeviceOptions_Basic =0x1, ProfisharkApiDeviceOptions_DualPorts =0x2, ProfisharkApiDeviceOptions_SpanMode =0x4, ProfisharkApiDeviceOptions_Gps =0x8,
  ProfisharkApiDeviceOptions_Update =0x10, ProfisharkApiDeviceOptions_Poe =0x20, ProfisharkApiDeviceOptions_Sfp =0x40, ProfisharkApiDeviceOptions_Filter =0x80,
  ProfisharkApiDeviceOptions_StatisticsV1 =0x100, ProfisharkApiDeviceOptions_StatisticsV2 =0x200, ProfisharkApiDeviceOptions_SpeedControl =0x400, ProfisharkApiDeviceOptions_Loopback =0x800,
  ProfisharkApiDeviceOptions_Phy88E3015 =0x2000, ProfisharkApiDeviceOptions_PhyVSC8641 =0x4000, ProfisharkApiDeviceOptions_PcapNG =0x8000, ProfisharkApiDeviceOptions_SlicingLength =0x10000,
  ProfisharkApiDeviceOptions_PhyVSC8502 =0x20000, ProfisharkApiDeviceOptions_MultipleHW =0x40000
}
 Profishark device capabilities. More...
 
enum  ProfisharkAPITimeSource {
  ProfisharkAPITimeSource_System, ProfisharkAPITimeSource_RTC, ProfisharkAPITimeSource_GPS, ProfisharkAPITimeSource_None,
  ProfisharkAPITimeSource_Manual, ProfisharkAPITimeSource_SNTP
}
 Time source for the timestamps. More...
 
enum  ProfisharkAPIState { ProfisharkAPIState_Disabled =0, ProfisharkAPIState_Enabled =1, ProfisharkAPIState_DontCare =-1 }
 Enabled/Disabled states. More...
 
enum  ProfisharkAPITimestampMoment { ProfisharkAPITimestampMoment_Capture, ProfisharkAPITimestampMoment_Ingress, ProfisharkAPITimestampMoment_Egress }
 Defines when the timestamp information is added to the packet. More...
 
enum  ProfisharkApiPortMode { ProfisharkApiPortMode_Inline, ProfisharkApiPortMode_Span }
 Port Mode. More...
 
enum  ProfisharkApiPortSpeed {
  ProfisharkApiPortSpeed_10Mbps, ProfisharkApiPortSpeed_100Mbps, ProfisharkApiPortSpeed_1Gbps, ProfisharkApiPortSpeed_10Gbps,
  ProfisharkApiPortSpeed_Unknown, ProfisharkApiPortSpeed_Down
}
 Link speed. More...
 
enum  ProfisharkApiPortDuplex { ProfisharkApiPortDuplex_Full, ProfisharkApiPortDuplex_Half }
 Link duplex. More...
 
enum  ProfisharkApiSFPPortsStatusEncoding {
  ProfisharkApiSFPPortsStatusEncoding_Unspecified =0x00, ProfisharkApiSFPPortsStatusEncoding_8B10B =0x01, ProfisharkApiSFPPortsStatusEncoding_4B5B =0x02, ProfisharkApiSFPPortsStatusEncoding_NRZ =0x03,
  ProfisharkApiSFPPortsStatusEncoding_Manchester =0x04, ProfisharkApiSFPPortsStatusEncoding_SONET_Scrambled =0x05, ProfisharkApiSFPPortsStatusEncoding_64B66B =0x06
}
 SFP module encoding. More...
 
enum  ProfisharkApiSFPPortsRateID {
  ProfisharkApiSFPPortsRateID_Unspecified =0x00, ProfisharkApiSFPPortsRateID_SFF_8079 =0x01, ProfisharkApiSFPPortsRateID_SFF_8431_RXOnly =0x02, ProfisharkApiSFPPortsRateID_SFF_8431_TXOnly =0x04,
  ProfisharkApiSFPPortsRateID_SFF_8431 =0x06, ProfisharkApiSFPPortsRateID_FC_PI_5_RXOnly =0x08, ProfisharkApiSFPPortsRateID_FC_PI_5 =0x0a
}
 SFP module rate ID. More...
 
enum  ProfisharkApiSFPPortsIdentifier {
  ProfisharkApiSFPPortsIdentifier_Unknown, ProfisharkApiSFPPortsIdentifier_GBIC, ProfisharkApiSFPPortsIdentifier_SolderedToMB, ProfisharkApiSFPPortsIdentifier_SFP_SFPPlus,
  ProfisharkApiSFPPortsIdentifier_300pinXBI, ProfisharkApiSFPPortsIdentifier_XENPAK, ProfisharkApiSFPPortsIdentifier_XFP, ProfisharkApiSFPPortsIdentifier_XFF,
  ProfisharkApiSFPPortsIdentifier_XFP_E, ProfisharkApiSFPPortsIdentifier_XPAK, ProfisharkApiSFPPortsIdentifier_X2, ProfisharkApiSFPPortsIdentifier_DWDM_SFP,
  ProfisharkApiSFPPortsIdentifier_QSFP, ProfisharkApiSFPPortsIdentifier_QSFPPlus, ProfisharkApiSFPPortsIdentifier_CXP
}
 SFP module identifier. More...
 
enum  ProfisharkApiSFPPortsConnector {
  ProfisharkApiSFPPortsConnector_Unknown, ProfisharkApiSFPPortsConnector_SC, ProfisharkApiSFPPortsConnector_FCStyle1Copper, ProfisharkApiSFPPortsConnector_FCStyle2Copper,
  ProfisharkApiSFPPortsConnector_BNC_TNC, ProfisharkApiSFPPortsConnector_FCCoax, ProfisharkApiSFPPortsConnector_FiberJack, ProfisharkApiSFPPortsConnector_LC,
  ProfisharkApiSFPPortsConnector_MT_RJ, ProfisharkApiSFPPortsConnector_MU, ProfisharkApiSFPPortsConnector_SG, ProfisharkApiSFPPortsConnector_OpticalPigtail,
  ProfisharkApiSFPPortsConnector_MPOParallelOptic, ProfisharkApiSFPPortsConnector_HSSDC_II, ProfisharkApiSFPPortsConnector_CopperPigtail, ProfisharkApiSFPPortsConnector_RJ45
}
 SFP module connector. More...
 
enum  ProfisharkApiSFPPortsDiagMonitoringType {
  ProfisharkApiSFPPortsDiagMonitoringType_IntCalibrated_AVPower, ProfisharkApiSFPPortsDiagMonitoringType_IntCalibrated_OMA, ProfisharkApiSFPPortsDiagMonitoringType_ExtCalibrated_AVPower, ProfisharkApiSFPPortsDiagMonitoringType_ExtCalibrated_OMA,
  ProfisharkApiSFPPortsDiagMonitoringType_None
}
 Diagnostic monitoring type. More...
 
enum  ProfisharkApiSFPPortsSFF8472 {
  ProfisharkApiSFPPortsSFF8472_Undefined, ProfisharkApiSFPPortsSFF8472_Rev9_3, ProfisharkApiSFPPortsSFF8472_Rev9_5, ProfisharkApiSFPPortsSFF8472_Rev10_2,
  ProfisharkApiSFPPortsSFF8472_Rev10_4, ProfisharkApiSFPPortsSFF8472_Rev_11_0
}
 SFF8472 compliance. More...
 
enum  ProfisharkApiSFPPortsDiagFlags {
  ProfisharkApiSFPPortsDiagFlags_Alarm_Temperature =0x1, ProfisharkApiSFPPortsDiagFlags_Alarm_VCC =0x2, ProfisharkApiSFPPortsDiagFlags_Alarm_TXBias =0x4, ProfisharkApiSFPPortsDiagFlags_Alarm_TXPower =0x8,
  ProfisharkApiSFPPortsDiagFlags_Alarm_RXPower =0x10, ProfisharkApiSFPPortsDiagFlags_Warning_Temperature =0x20, ProfisharkApiSFPPortsDiagFlags_Warning_VCC =0x40, ProfisharkApiSFPPortsDiagFlags_Warning_TXBias =0x80,
  ProfisharkApiSFPPortsDiagFlags_Warning_TXPower =0x100, ProfisharkApiSFPPortsDiagFlags_Warning_RXPower =0x200, ProfisharkApiSFPPortsDiagFlags_Gpio_TXDisable =0x400, ProfisharkApiSFPPortsDiagFlags_Gpio_TXFault =0x800,
  ProfisharkApiSFPPortsDiagFlags_Gpio_RXLOS =0x1000
}
 SFP module alarm, warning and gpios.
 
enum  ProfisharkApiSFPPortsOptionsLaserType { ProfisharkApiSFPPortsOptionsLaser_Cooled, ProfisharkApiSFPPortsOptionsLaser_Uncooled_Unspecified }
 SFP module Laser type. More...
 
enum  ProfisharkApiSFPPortsOptionsLaserPower { ProfisharkApiSFPPortsOptionsLaserPower_Level2, ProfisharkApiSFPPortsOptionsLaserPower_Level1_Unspecified }
 SFP module Laser power. More...
 
enum  ProfisharkApiSFPPortsOptionsReceiverOutput { ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Linear, ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Limiting }
 SFP module receiver output type. More...
 
enum  ProfisharkApiSFPPortsImplementation { ProfisharkApiSFPPortsImplementation_Implemented, ProfisharkApiSFPPortsImplementation_NotImplemented, ProfisharkApiSFPPortsImplementation_Implemented_Inverted }
 implementation state for various SFP module features More...
 
enum  ProfisharkApiSFPPortsSONETReachSpecifier {
  ProfisharkApiSFPPortsSONETReachSpecifier_SR, ProfisharkApiSFPPortsSONETReachSpecifier_SR_1, ProfisharkApiSFPPortsSONETReachSpecifier_IR_1, ProfisharkApiSFPPortsSONETReachSpecifier_IR_2,
  ProfisharkApiSFPPortsSONETReachSpecifier_LR_1, ProfisharkApiSFPPortsSONETReachSpecifier_LR_2, ProfisharkApiSFPPortsSONETReachSpecifier_LR_3, ProfisharkApiSFPPortsSONETReachSpecifier_Unknown
}
 SFP module SONET reach specifier.
 
enum  ProfisharkApiPHYRegistersMasterSlave { ProfisharkApiPHYRegistersMasterSlave_Master, ProfisharkApiPHYRegistersMasterSlave_Slave, ProfisharkApiPHYRegistersMasterSlave_NA }
 State of the master/slave resolution.
 
enum  ProfisharkApiStatisticsVersion { ProfisharkApiStatisticsVersion_1 =1, ProfisharkApiStatisticsVersion_2 =2 }
 Statistics model version.
 
enum  ProfisharkApiCounterV2SizeMode { ProfisharkApiCounterV2SizeMode_SizeModeDontCare =-1, ProfisharkApiCounterV2SizeMode_SizeModeGreaterThan, ProfisharkApiCounterV2SizeMode_SizeModeLessThan, ProfisharkApiCounterV2SizeMode_SizeModeEqual }
 Counter V2 size comparison mode. More...
 
enum  ProfisharkApiCounterV2Mode { ProfisharkApiCounterV2Mode_CounterModePackets, ProfisharkApiCounterV2Mode_CounterModeBytes }
 Counter V2 mode. More...
 
enum  ProfisharkApiPacketFilterFlags {
  ProfisharkApiPacketFilterFlags_isIPV6 = 0x1, ProfisharkApiPacketFilterFlags_dstMacEnabled = 0x2, ProfisharkApiPacketFilterFlags_srcMacEnabled = 0x4, ProfisharkApiPacketFilterFlags_dstIpEnabled = 0x8,
  ProfisharkApiPacketFilterFlags_srcIpEnabled = 0x10, ProfisharkApiPacketFilterFlags_dstPortEnabled = 0x20, ProfisharkApiPacketFilterFlags_srcPortEnabled = 0x40
}
 Flags that enable of disable filters fields. More...
 
enum  ProfisharkApiPacketFilterMode { ProfisharkApiPacketFilterMode_macIsOr = 0x1, ProfisharkApiPacketFilterMode_ipIsOr = 0x2, ProfisharkApiPacketFilterMode_portIsOr = 0x4 }
 Modes defining the comportement of packet filter fields. More...
 
enum  ProfisharkAPITimingBoardState { ProfisharkAPITimingBoardState_Available, ProfisharkAPITimingBoardState_Absent, ProfisharkAPITimingBoardState_Locked }
 State of device timing board. More...
 
enum  ProfisharkAPITimingFixState { ProfisharkAPITimingFixState_NoFix, ProfisharkAPITimingFixState_2DFix, ProfisharkAPITimingFixState_3DFix }
 State of the gps chip. More...
 
enum  ProfisharkAPINetworkDataFormat { ProfisharkAPINetworkDataFormat_PcapNG }
 Output file format. More...
 
enum  ProfisharkApiGlobalCallbackType { ProfisharkApiGlobalCallbackType_NewDevice, ProfisharkApiGlobalCallbackType_DeviceRemoved }
 
enum  ProfisharkApiDeviceCallbackType { ProfisharkApiDeviceCallbackType_DiskDump }
 

Functions

PROFISHARKAPI_API void ProfisharkApiSleepMs (int ms)
 Sleeps for ms milliseconds.
 
PROFISHARKAPI_API ProfisharkApiSWVersion ProfisharkAPIGetVersion (void)
 Get API version.
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIInitialize (void)
 Initialize the Profishark library. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIUninitialize (void)
 Cleanup internal library structures. More...
 
PROFISHARKAPI_API void ProfisharkApiDeviceListFree (ProfisharkApiDeviceList *list)
 
PROFISHARKAPI_API ProfisharkApiDeviceListProfisharkAPIGetDevicesList (void)
 Get a list containing the currently connected Profishark devices. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIAddNewDeviceCallback (ProfisharkApiCallback callback, void *context)
 Add a new function to be called when a new Profishark device is detected. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRemoveNewDeviceCallback (ProfisharkApiCallback callback)
 Remove a function from the list of functions called when a new Profishark device is detected. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIAddDeviceGoneCallback (ProfisharkApiCallback callback, void *context)
 Add a new function to be called when a Profishark device is disconnected. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRemoveDeviceGoneCallback (ProfisharkApiCallback callback)
 Remove a function from the list of functions called when a new Profishark device is disconnected. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceType (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceType &type)
 Get device type. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceMAC (ProfisharkApiDeviceHandle handle, uint8_t *mac)
 Get device MAC address. More...
 
PROFISHARKAPI_API ProfisharkApiDeviceOptions ProfisharkAPIGetDeviceCapabilities (ProfisharkAPIDeviceType devType)
 Get device capabilities. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceExtraInfo (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceExtraInfo &info)
 Get device extra information. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceFeatures (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceFeatures &features)
 Get device features. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDeviceFeatures (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceFeatures features)
 Set device features. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetHwFirmwaresDesc (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceHWFirmwaresDesc &desc)
 Get the name corresponding to a HW firmware id. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDevicePortsSpeed (ProfisharkApiDeviceHandle handle, ProfisharkAPIDevicePortsSpeed speed)
 Set network ports supported speeds. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDevicePortsSpeed (ProfisharkApiDeviceHandle handle, ProfisharkAPIDevicePortsSpeed &speed)
 Get network ports supported speeds. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISaveDeviceFeatures (ProfisharkApiDeviceHandle handle)
 Save device features and ports speed to EEPROM. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRestartDevice (ProfisharkApiDeviceHandle handle)
 Restart the device. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetVersions (ProfisharkApiDeviceHandle handle, ProfisharkApiVersions &versions)
 Get device firmwares and driver versions. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetLinkStatus (ProfisharkApiDeviceHandle handle, ProfisharkApiLinkStatus &status)
 Get device link status. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetStatistics (ProfisharkApiDeviceHandle handle, ProfisharkApiStatistics &statistics)
 Get device statistics. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetCounterV2 (ProfisharkApiDeviceHandle handle, ProfisharkApiCounterV2 counter)
 Set device counter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetCounterV2 (ProfisharkApiDeviceHandle handle, int n, ProfisharkApiCounterV2 &counter)
 Get device counter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDpiFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiDpiFilter filter)
 Set DPI filter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDpiFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiDpiFilter &filter)
 Get DPI filter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISaveDpiFilter (ProfisharkApiDeviceHandle handle)
 Save DPI filter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetPacketFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiPacketFilter filter)
 Set packet filter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetPacketFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiPacketFilter &filter)
 Get packet filter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISavePacketFilter (ProfisharkApiDeviceHandle handle)
 Save packet filter configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetTimingTime (ProfisharkApiDeviceHandle handle, ProfisharkAPITimingTime time)
 Set timestamp time information. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetTimingStatus (ProfisharkApiDeviceHandle handle, ProfisharkAPITimingStatus &status)
 Get timing board status. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIDiskDumpSetConfig (ProfisharkApiDeviceHandle handle, ProfisharkAPIDiskDumpConfig config)
 Set direct capture configuration. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIDiskDumpStart (ProfisharkApiDeviceHandle handle)
 Start direct capture. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIDiskDumpStop (ProfisharkApiDeviceHandle handle)
 Stop direct capture. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIDiskDumpGetStatus (ProfisharkApiDeviceHandle handle, ProfisharkAPIDiskDumpStatus &status)
 Get direct capture status. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIMemoryCaptureStart (ProfisharkApiDeviceHandle handle, ProfisharkAPIMemoryCaptureConfig config)
 Start memory capture. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIMemoryCaptureStop (ProfisharkApiDeviceHandle handle)
 Stop memory capture. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIMemoryCaptureGet (ProfisharkApiDeviceHandle handle, uint8_t *buffer, int &length)
 Get network data. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIMemoryCaptureGetHeader (ProfisharkApiDeviceHandle handle, uint8_t *buffer, int &length)
 Get the file header corresponding to the requested format. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGPSOutputFlush (ProfisharkApiDeviceHandle handle)
 Flush GPS UART output interface. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGPSOutputRead (ProfisharkApiDeviceHandle handle, char *data, int len, int *transferred)
 Fetch data from the GPS UART output interface. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIAddGlobalCallback (ProfisharkApiGlobalCallbackType type, ProfisharkApiCallbackExt callback, void *context)
 Add a global callback function. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIAddDeviceCallback (ProfisharkApiDeviceHandle handle, ProfisharkApiDeviceCallbackType type, ProfisharkApiCallbackExt callback, void *context)
 Add a device callback function. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRemoveGlobalCallback (ProfisharkApiGlobalCallbackType type, ProfisharkApiCallbackExt callback)
 Remove a global callback function. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRemoveDeviceCallback (ProfisharkApiDeviceHandle handle, ProfisharkApiDeviceCallbackType type, ProfisharkApiCallbackExt callback)
 Remove a device callback function. More...
 

Detailed Description

Main API header file

Macro Definition Documentation

◆ IS_PROFISHARK_API_SUCCESS

#define IS_PROFISHARK_API_SUCCESS (   a)    (a==ProfisharkAPIRet_Success)

Returns if the value means success.

Parameters
aProfisharkAPIRet value
Returns
whether the ProfisharkAPIRet corresponds to a success

Enumeration Type Documentation

◆ ProfisharkAPIFlagState

State of a flag.

Enumerator
ProfisharkAPIFlagState_No 

Feature is OFF/not OK/not detected

ProfisharkAPIFlagState_Yes 

Feature is ON/OK/detected

ProfisharkAPIFlagState_Unknown 

State is not available/unknown

◆ ProfisharkAPIRet

Error constants.

Enumerator
ProfisharkAPIRet_Success 

No error

ProfisharkAPIRet_Failed 

Generic failure

ProfisharkAPIRet_Exist 

Already exists

ProfisharkAPIRet_NotExist 

Does not exist

ProfisharkAPIRet_NoDev 

Device does not exist

ProfisharkAPIRet_Unsupported 

Device does not support this operation

ProfisharkAPIRet_CannotCreateFile 

Failed to create file

ProfisharkAPIRet_CannotAllocateCache 

Failed to allocate cache, out of memory

ProfisharkAPIRet_CaptureNotReady 

Capture is not ready to start

ProfisharkAPIRet_CacheTooSmall 

Cache is too small (<512kb)

ProfisharkAPIRet_TooSmall 

Not enough space

ProfisharkAPIRet_NotImplemented 

Not implemented in API

ProfisharkAPIRet_NotReady 

Buffer not ready

ProfisharkAPIRet_Again 

Try again

ProfisharkAPIRet_CannotOpenFile 

Failed to open file

ProfisharkAPIRet_InvalidFirmware 

Invalid firmware file

ProfisharkAPIRet_NotStarted 

Invalid firmware file

◆ ProfisharkAPIState

Enabled/Disabled states.

Enumerator
ProfisharkAPIState_Disabled 

Disabled

ProfisharkAPIState_Enabled 

Enabled

ProfisharkAPIState_DontCare 

Don't Care