]>
Commit | Line | Data |
---|---|---|
4deb8948 MW |
1 | /** |
2 | * @file process_message_job.h | |
3 | * | |
4 | * @brief Interface of process_message_job_t. | |
5 | * | |
6 | */ | |
7 | ||
8 | /* | |
9 | * Copyright (C) 2005-2007 Martin Willi | |
10 | * Copyright (C) 2005 Jan Hutter | |
11 | * Hochschule fuer Technik Rapperswil | |
12 | * | |
13 | * This program is free software; you can redistribute it and/or modify it | |
14 | * under the terms of the GNU General Public License as published by the | |
15 | * Free Software Foundation; either version 2 of the License, or (at your | |
16 | * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>. | |
17 | * | |
18 | * This program is distributed in the hope that it will be useful, but | |
19 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY | |
20 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
21 | * for more details. | |
22 | */ | |
23 | ||
24 | #ifndef PROCESS_MESSAGE_JOB_H_ | |
25 | #define PROCESS_MESSAGE_JOB_H_ | |
26 | ||
27 | typedef struct process_message_job_t process_message_job_t; | |
28 | ||
29 | #include <library.h> | |
30 | #include <encoding/message.h> | |
e0fe7651 | 31 | #include <processing/jobs/job.h> |
4deb8948 MW |
32 | |
33 | /** | |
34 | * @brief Class representing an PROCESS_MESSAGE job. | |
35 | * | |
36 | * @b Constructors: | |
37 | * - process_message_job_create() | |
38 | * | |
39 | * @ingroup jobs | |
40 | */ | |
41 | struct process_message_job_t { | |
42 | /** | |
43 | * implements job_t interface | |
44 | */ | |
45 | job_t job_interface; | |
46 | }; | |
47 | ||
48 | /** | |
49 | * @brief Creates a job of type PROCESS_MESSAGE. | |
50 | * | |
51 | * @param message message to process | |
52 | * @return created process_message_job_t object | |
53 | * | |
54 | * @ingroup jobs | |
55 | */ | |
56 | process_message_job_t *process_message_job_create(message_t *message); | |
57 | ||
58 | #endif /*PROCESS_MESSAGE_JOB_H_*/ |