diff options
Diffstat (limited to 'src/messenger/gnunet-service-messenger_operation.h')
-rw-r--r-- | src/messenger/gnunet-service-messenger_operation.h | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/src/messenger/gnunet-service-messenger_operation.h b/src/messenger/gnunet-service-messenger_operation.h new file mode 100644 index 000000000..7757b8e88 --- /dev/null +++ b/src/messenger/gnunet-service-messenger_operation.h | |||
@@ -0,0 +1,129 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2021 GNUnet e.V. | ||
4 | |||
5 | GNUnet is free software: you can redistribute it and/or modify it | ||
6 | under the terms of the GNU Affero General Public License as published | ||
7 | by the Free Software Foundation, either version 3 of the License, | ||
8 | or (at your option) any later version. | ||
9 | |||
10 | GNUnet is distributed in the hope that it will be useful, but | ||
11 | WITHOUT ANY WARRANTY; without even the implied warranty of | ||
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
13 | Affero General Public License for more details. | ||
14 | |||
15 | You should have received a copy of the GNU Affero General Public License | ||
16 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
17 | |||
18 | SPDX-License-Identifier: AGPL3.0-or-later | ||
19 | */ | ||
20 | /** | ||
21 | * @author Tobias Frisch | ||
22 | * @file src/messenger/gnunet-service-messenger_operation.h | ||
23 | * @brief GNUnet MESSENGER service | ||
24 | */ | ||
25 | |||
26 | #ifndef GNUNET_SERVICE_MESSENGER_OPERATION_H | ||
27 | #define GNUNET_SERVICE_MESSENGER_OPERATION_H | ||
28 | |||
29 | #include "platform.h" | ||
30 | #include "gnunet_configuration_lib.h" | ||
31 | #include "gnunet_crypto_lib.h" | ||
32 | #include "gnunet_scheduler_lib.h" | ||
33 | #include "gnunet_strings_lib.h" | ||
34 | #include "gnunet_time_lib.h" | ||
35 | |||
36 | enum GNUNET_MESSENGER_OperationType | ||
37 | { | ||
38 | GNUNET_MESSENGER_OP_REQUEST = 1, | ||
39 | GNUNET_MESSENGER_OP_DELETE = 2, | ||
40 | GNUNET_MESSENGER_OP_MERGE = 3, | ||
41 | |||
42 | GNUNET_MESSENGER_OP_UNKNOWN = 0 | ||
43 | }; | ||
44 | |||
45 | struct GNUNET_MESSENGER_OperationStore; | ||
46 | |||
47 | struct GNUNET_MESSENGER_Operation | ||
48 | { | ||
49 | enum GNUNET_MESSENGER_OperationType type; | ||
50 | |||
51 | struct GNUNET_HashCode hash; | ||
52 | struct GNUNET_TIME_Absolute timestamp; | ||
53 | |||
54 | struct GNUNET_MESSENGER_OperationStore *store; | ||
55 | struct GNUNET_SCHEDULER_Task* task; | ||
56 | }; | ||
57 | |||
58 | /** | ||
59 | * Creates and allocates a new operation under a given <i>hash</i>. | ||
60 | * | ||
61 | * @param[in] hash Hash of message | ||
62 | */ | ||
63 | struct GNUNET_MESSENGER_Operation* | ||
64 | create_operation (const struct GNUNET_HashCode *hash); | ||
65 | |||
66 | /** | ||
67 | * Destroys an operation and frees its memory fully. | ||
68 | * | ||
69 | * @param[in/out] op Operation | ||
70 | */ | ||
71 | void | ||
72 | destroy_operation (struct GNUNET_MESSENGER_Operation *op); | ||
73 | |||
74 | /** | ||
75 | * Loads data from a configuration file at a selected <i>path</i> into | ||
76 | * a new allocated and created operation for a specific operation | ||
77 | * <i>store</i> if the required information could be read successfully. | ||
78 | * | ||
79 | * The method will return the new operation and it will be started | ||
80 | * automatically to match its timestamp of execution. | ||
81 | * | ||
82 | * If the method fails to restore any valid operation from the file, | ||
83 | * NULL gets returned instead. | ||
84 | * | ||
85 | * @param[in/out] store Operation store | ||
86 | * @param[in] path Path of a configuration file | ||
87 | */ | ||
88 | struct GNUNET_MESSENGER_Operation* | ||
89 | load_operation (struct GNUNET_MESSENGER_OperationStore *store, const char *path); | ||
90 | |||
91 | /** | ||
92 | * Saves data from an <i>operation</i> into a configuration file at a | ||
93 | * selected <i>path</i> which can be load to restore the operation | ||
94 | * completely and continue its process. | ||
95 | * | ||
96 | * @param[in] op Operation | ||
97 | * @param[in] path Path of a configuration file | ||
98 | */ | ||
99 | void | ||
100 | save_operation (const struct GNUNET_MESSENGER_Operation *op, const char *path); | ||
101 | |||
102 | /** | ||
103 | * Starts an inactive operation with a given <i>delay</i> in a | ||
104 | * specific operation <i>store</i>. The method will replace the | ||
105 | * operations type to process it correctly. An opeation can't be | ||
106 | * started twice, it has to be stopped or fully processed first. | ||
107 | * | ||
108 | * @param[in/out] op Operation | ||
109 | * @param[in] type Type of operation | ||
110 | * @param[in/out] store Operation store | ||
111 | * @param[in] delay Delay | ||
112 | * @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR | ||
113 | */ | ||
114 | int | ||
115 | start_operation (struct GNUNET_MESSENGER_Operation *op, | ||
116 | enum GNUNET_MESSENGER_OperationType type, | ||
117 | struct GNUNET_MESSENGER_OperationStore *store, | ||
118 | struct GNUNET_TIME_Relative delay); | ||
119 | |||
120 | /** | ||
121 | * Stops an active operation and resets its type to be | ||
122 | * #GNUNET_MESSENGER_OP_UNKNOWN. | ||
123 | * | ||
124 | * @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR | ||
125 | */ | ||
126 | int | ||
127 | stop_operation (struct GNUNET_MESSENGER_Operation *op); | ||
128 | |||
129 | #endif //GNUNET_SERVICE_MESSENGER_OPERATION_H | ||