/* Chrysalide - Outil d'analyse de fichiers binaires
 * workgroup.h - prototypes pour la gestion des travaux différés
 *
 * Copyright (C) 2009-2024 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Chrysalide is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _GLIBEXT_WORKGROUP_H
#define _GLIBEXT_WORKGROUP_H


#include <stdbool.h>
#include <stdint.h>


#include "helpers.h"
#include "work.h"



#define G_TYPE_WORK_GROUP (g_work_group_get_type())

DECLARE_GTYPE(GWorkGroup, g_work_group, G, WORK_GROUP);


/**
 * Identifiant unique pour groupe de travail.
 *
 * Le nombre de bits est forcé à 64 bits car glib-genmarshal ne reconnait
 * pas explicitement le type 'unsigned long long'.
 */
typedef uint64_t wgroup_id_t;

/**
 * Marque de non initialisation.
 */
#define INVALID_GROUP_ID 0


/* Crée un nouveau thread dédié à un type de travaux donné. */
GWorkGroup *g_work_group_new(wgroup_id_t, guint);

/* Fournit l'identifiant associé à un groupe de travail. */
wgroup_id_t g_work_group_get_id(const GWorkGroup *);

/* Place une nouvelle tâche en attente dans une file dédiée. */
void g_work_group_schedule(GWorkGroup *, GGenericWork *);

/* Détermine si le groupe est vide de toute programmation. */
bool g_work_group_is_empty(GWorkGroup *);

/* Attend que toutes les tâches d'un groupe soient traitées. */
void g_work_group_wait_for_completion(GWorkGroup *);

/* Attend que toutes les tâches d'un groupe soient traitées. */
bool g_work_group_wait_timed_for_completion(GWorkGroup *, gint64);

/* Force un réveil d'une attente en cours pour la confirmer. */
void g_work_group_wake_up_waiters(GWorkGroup *);



#endif  /* _GLIBEXT_WORKGROUP_H */