annotate libsci/apic.h @ 33:1d0ddf9e6efd

misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents lib/apic.h@dae2de19ca5d
children e52c762d8ba8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
1 /*
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
2 * apic.h -- synchronous HTTP request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
3 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
5 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
8 * copyright notice and this permission notice appear in all copies.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
9 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
17 */
1d0ddf9e6efd misc: general documentation
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 SCI_APIC_H
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_APIC_H
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <jansson.h>
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #define APIC_ERR_MAX 128
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
26 struct apic {
19
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 char error[APIC_ERR_MAX];
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 long status;
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 };
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
31 extern struct apiconf {
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
32 char baseurl[512];
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
33 } apiconf /*! Global variable. */;
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
34
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
35 json_t *
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
36 apic_get(struct apic *, const char *, ...);
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
37
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
38 json_t *
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
39 apic_post(struct apic *, const json_t *, const char *, ...);
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
40
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
41 int
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
42 apic_job_add(struct apic *, json_t *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
43
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
44 json_t *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
45 apic_job_todo(struct apic *, const char *);
19
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 int
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
48 apic_jobresult_add(struct apic *, json_t *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
49
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
50 int
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
51 apic_project_save(struct apic *, json_t *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
52
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
53 json_t *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
54 apic_project_list(struct apic *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
55
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
56 json_t *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
57 apic_project_find(struct apic *, const char *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
58
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
59 int
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
60 apic_worker_save(struct apic *, json_t *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
61
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
62 json_t *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
63 apic_worker_list(struct apic *);
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
64
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
65 json_t *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents: 23
diff changeset
66 apic_worker_find(struct apic *, const char *);
19
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 #endif /* !SCI_APIC_H */