annotate sciworkerd/sciworkerd.h @ 34:e52c762d8ba8

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