annotate scid/page-workers.h @ 47:e8f24896b484

scid: add /workers page
author David Demelier <markand@malikania.fr>
date Tue, 16 Aug 2022 18:29:08 +0200
parents
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * page-workers.h -- page /workers/<name> route
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_PAGE_WORKERS_H
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_PAGE_WORKERS_H
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file page-workers.h
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Page /workers/id route.
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 *
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 * This module does not log messages.
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 */
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct kreq;
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 /**
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * Run the page.
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 *
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * \pre r != NULL
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 * \param r the request
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 */
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 void
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 page_workers(struct kreq *r);
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
e8f24896b484 scid: add /workers page
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 #endif /* !SCI_PAGE_WORKERS_H */