Callback mechanism.
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 | 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...
|
|
Callback mechanism.
Callback function.
- Parameters
-
Profishark callback value.
Opaque type used by callback functions. To be used, this needs to be cast to the proper type depending on the callback type
\ brief Device specific callback types
Enumerator |
---|
ProfisharkApiDeviceCallbackType_DiskDump |
Function is called on direct capture events (capture start, capture stop). ProfisharkApiCallbackValue is to be cast as ProfisharkApiCallbackValue_DiskDump
|
\ brief Global callback types
Enumerator |
---|
ProfisharkApiGlobalCallbackType_NewDevice |
Function is called on device insertion. ProfisharkApiCallbackValue is not used
|
ProfisharkApiGlobalCallbackType_DeviceRemoved |
Function is called on device removal. ProfisharkApiCallbackValue is not used
|
Add a device callback function.
- Parameters
-
handle | a handle to the device |
type | the type of callback to add. This defines when the function is called. |
callback | the function to be called |
context | a pointer passed to the callback function |
- Return values
-
ProfisharkAPIRet_Success | on success |
Add a new function to be called when a Profishark device is disconnected.
- Parameters
-
callback | the function to be called |
context | the parameter passed to the function to be called |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_Exist | if the function is already registered |
- Deprecated:
- Deprecated, use ProfisharkAPIAddGlobalCallback
Add a global callback function.
- Parameters
-
type | the type of callback to add. This defines when the function is called. |
callback | the function to be called |
context | a pointer passed to the callback function |
- Return values
-
ProfisharkAPIRet_Success | on success |
Add a new function to be called when a new Profishark device is detected.
- Parameters
-
callback | the function to be called |
context | the parameter passed to the function to be called |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_Exist | if the function is already registered |
- Deprecated:
- Deprecated, use ProfisharkAPIAddGlobalCallback
Remove a device callback function.
- Parameters
-
handle | a handle to the device |
type | the type of callback to remove. Must be the same as the one used for the ProfisharkAPIAddDeviceCallback call. |
callback | the function to be removed |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NotExist | if the function was not registered |
Remove a function from the list of functions called when a new Profishark device is disconnected.
- Parameters
-
callback | the function to be removed |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NotExist | if the function was not registered |
- Deprecated:
- Deprecated, use ProfisharkAPIRemoveGlobalCallback
Remove a global callback function.
- Parameters
-
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NotExist | if the function was not registered |
Remove a function from the list of functions called when a new Profishark device is detected.
- Parameters
-
callback | the function to be removed |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NotExist | if the function was not registered |
- Deprecated:
- Deprecated, use ProfisharkAPIRemoveGlobalCallback