1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
|
/**
* @file
* Config used by the Progress Bar
*
* @authors
* Copyright (C) 2024 Richard Russon <rich@flatcap.org>
*
* @copyright
* This program 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 2 of the License, or (at your option) any later
* version.
*
* This program 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
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @page progress_config Config used by the Progress Bar
*
* Config used by the Progress Bar
*/
#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "config/lib.h"
/**
* ProgressVars - Config definitions for the Progress Bar
*/
static struct ConfigDef ProgressVars[] = {
// clang-format off
{ "net_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
"(socket) Update the progress bar after this many KB sent/received (0 to disable)"
},
{ "read_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
"Update the progress bar after this many records read (0 to disable)"
},
{ "time_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
"Frequency of progress bar updates (milliseconds)"
},
{ "write_inc", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 10, 0, NULL,
"Update the progress bar after this many records written (0 to disable)"
},
{ NULL },
// clang-format on
};
/**
* config_init_progress - Register progress config variables - Implements ::module_init_config_t - @ingroup cfg_module_api
*/
bool config_init_progress(struct ConfigSet *cs)
{
return cs_register_variables(cs, ProgressVars);
}
|