Mercurial > sci
annotate sciworkerd/sciworkerd.h @ 60:3804a2ab60ec
misc: documentation improvements
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 18 Aug 2022 10:12:54 +0200 |
| parents | 95bc6b4ec753 |
| children | 71cd8447e3a4 |
| rev | line source |
|---|---|
| 34 | 1 /* |
| 2 * sciworkerd.h -- main sciworkerd file | |
| 3 * | |
| 4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr> | |
| 5 * | |
| 6 * Permission to use, copy, modify, and/or distribute this software for any | |
| 7 * purpose with or without fee is hereby granted, provided that the above | |
| 8 * copyright notice and this permission notice appear in all copies. | |
| 9 * | |
| 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 17 */ | |
| 18 | |
| 19 | 19 #ifndef SCIWORKERD_H |
| 20 #define SCIWORKERD_H | |
| 21 | |
| 34 | 22 /** |
| 23 * \file sciworkerd.h | |
| 24 * \brief Main sciworkerd file. | |
| 25 */ | |
| 26 | |
| 27 /** | |
| 28 * \brief Maximum worker name. | |
| 29 */ | |
|
27
dae2de19ca5d
misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
30 #define SCIWORKERD_NAME_MAX 64 |
| 19 | 31 |
| 34 | 32 /** |
| 33 * \brief Main sciworkerd configuration structure. | |
| 34 */ | |
| 19 | 35 extern struct sciworkerd { |
| 34 | 36 char name[SCIWORKERD_NAME_MAX]; /*!< This worker name to use. */ |
| 37 unsigned int fetchinterval; /*!< Delay in seconds before fetching jobs. */ | |
| 38 unsigned int maxjobs; /*!< Maximum parallel jobs. */ | |
| 39 unsigned int timeout; /*!< Maximum time in seconds before killing a job. */ | |
| 40 } sciworkerd /*! Global variable. */; | |
| 19 | 41 |
| 34 | 42 /** |
| 43 * Initialize sciworkerd. | |
| 44 */ | |
| 19 | 45 void |
| 46 sciworkerd_init(void); | |
| 47 | |
| 34 | 48 /** |
| 49 * Run forever. | |
| 50 */ | |
| 19 | 51 void |
| 52 sciworkerd_run(void); | |
| 53 | |
| 34 | 54 /** |
| 55 * Cleanup sciworkerd resources and kill remaining tasks. | |
| 56 */ | |
| 19 | 57 void |
| 58 sciworkerd_finish(void); | |
| 59 | |
| 60 #endif /* !SCIWORKERD_H */ |