iqr_watchdog.h File Reference

ISARA Radiate Security Solution Suite's watchdog callback. More...

Typedefs
typedef iqr_retval(*	iqr_WatchdogCallback) (void *watchdog_data)

Functions
IQR_API iqr_retval	iqr_WatchdogRegisterCallback (iqr_Context *ctx, iqr_WatchdogCallback watchdog_func, void *watchdog_data)

Typedef Documentation

iqr_WatchdogCallback

typedef iqr_retval(* iqr_WatchdogCallback) (void *watchdog_data)

A function called whenever the watchdog callback is triggered.

Parameters

[in]

watchdog_data

A pointer to data, set during the call to iqr_WatchdogRegisterCallback(). This can point to whatever data is appropriate for your application.

Returns

IQR_OK for success, or a value from iqr_retval.h when an error occurs. If an error occurs, the calling function will return without finishing its task.

Function Documentation

iqr_WatchdogRegisterCallback()

IQR_API iqr_retval iqr_WatchdogRegisterCallback	(	iqr_Context *	ctx,
		iqr_WatchdogCallback	watchdog_func,
		void *	watchdog_data
	)

Register a "watchdog" callback function.

Some toolkit functions can take a significant amount of time. The watchdog function will be called periodically while these functions are executing. Use this function to display a progress indicator or to tell your operating environment that the process hasn't crashed, for example.

If the watchdog function returns a value other than IQR_OK, the calling function will return without finishing its task. The calling function will return the watchdog's return value.

Individual algorithms will document when they trigger the watchdog callback.

To disable the watchdog function, call iqr_ContextRegisterWatchdog() with NULL as the watchdog_func.

Use the watchdog_data argument to provide a pointer that will be passed into your watchdog function every time it's called. You can use this to provide data to the watchdog function.

Parameters

[in]	ctx	Context pointer.
[in]	watchdog_func	Pointer to a watchdog function.
[in]	watchdog_data	Pointer to data that will be passed to the watchdog_func when it gets called.

Returns

IQR_OK on success, or a value from iqr_retval.h when an error occurs.

Detailed Description

ISARA Radiate Security Solution Suite's watchdog callback.

Copyright

Copyright 2018, ISARA Corporation, All Rights Reserved.

License

The code and other content set out herein is not in the public domain, is considered a trade secret and is confidential to ISARA Corporation. Use, reproduction or distribution, in whole or in part, of such code or other content is strictly prohibited except by express written permission of ISARA Corporation. Please contact ISARA Corporation at info@.nosp@m.isar.nosp@m.a.com for more information.