v0.2.1
Fast, portable C library for geometry input/output
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Modules
Data Fields
gmio_task_iface Struct Reference

Defines an interface through which a task can be controlled. More...

Data Fields

void * cookie
 Optional opaque pointer on a user task object, passed as first argument to hook functions. More...
 
bool(* func_is_stop_requested )(void *cookie)
 Optional pointer on a function that says if the currently running task must stop. More...
 
void(* func_handle_progress )(void *cookie, intmax_t value, intmax_t max_value)
 Optional pointer on a function that is called anytime some new progress was done. More...
 

Detailed Description

Defines an interface through which a task can be controlled.

Field Documentation

void* gmio_task_iface::cookie

Optional opaque pointer on a user task object, passed as first argument to hook functions.

void(* gmio_task_iface::func_handle_progress)(void *cookie, intmax_t value, intmax_t max_value)

Optional pointer on a function that is called anytime some new progress was done.

Parameters
cookieThe cookie set inside the gmio_task_iface object
valueCurrent value of the task progress (<= max_value )
max_valueMaximum value of the task progress
bool(* gmio_task_iface::func_is_stop_requested)(void *cookie)

Optional pointer on a function that says if the currently running task must stop.

If true is returned then the current task should abort as soon as possible, otherwise it can continue execution.


The documentation for this struct was generated from the following file:
Fougue © 2016