gmio/0.2/task__iface_8h_source.html

 /****************************************************************************

 ** gmio

 ** Copyright Fougue (24 Jun. 2016)

 ** contact@fougue.pro

 **

 ** This software is a reusable library whose purpose is to provide complete

 ** I/O support for various CAD file formats (eg. STL)

 **

 ** This software is governed by the CeCILL-B license under French law and

 ** abiding by the rules of distribution of free software.  You can  use,

 ** modify and/ or redistribute the software under the terms of the CeCILL-B

 ** license as circulated by CEA, CNRS and INRIA at the following URL

 ** "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html".

 ****************************************************************************/


 #ifndef GMIO_TASK_IFACE_H

 #define GMIO_TASK_IFACE_H


 #include "global.h"


 struct gmio_task_iface

 {

     void* cookie;


     bool (*func_is_stop_requested)(void* cookie);


     void (*func_handle_progress)(

             void* cookie, intmax_t value, intmax_t max_value);

 };


 #endif /* GMIO_TASK_IFACE_H */


gmio_task_iface::cookie
void * cookie
Optional opaque pointer on a user task object, passed as first argument to hook functions.
Definition: task_iface.h:33

global.h
Fundamental global declarations, included by almost all other header/source files.

gmio_task_iface::func_is_stop_requested
bool(* func_is_stop_requested)(void *cookie)
Optional pointer on a function that says if the currently running task must stop. ...
Definition: task_iface.h:41

gmio_task_iface::func_handle_progress
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. ...
Definition: task_iface.h:50

gmio_task_iface
Defines an interface through which a task can be controlled.
Definition: task_iface.h:29