diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2023-10-19 12:53:29 +0200 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2023-10-19 12:53:29 +0200 |
commit | 7ef64b65a42cdb65ef2e36649ff84fcf4bb00c66 (patch) | |
tree | 975a7cebf0ed685ab776152db1be67d01171c6e5 /src/messenger/gnunet-service-messenger_operation.h | |
parent | 39e327905f421c470b9cbd5c1ea548261bcae026 (diff) | |
download | gnunet-7ef64b65a42cdb65ef2e36649ff84fcf4bb00c66.tar.gz gnunet-7ef64b65a42cdb65ef2e36649ff84fcf4bb00c66.zip |
BUILD: Move messenger to service
Diffstat (limited to 'src/messenger/gnunet-service-messenger_operation.h')
-rw-r--r-- | src/messenger/gnunet-service-messenger_operation.h | 130 |
1 files changed, 0 insertions, 130 deletions
diff --git a/src/messenger/gnunet-service-messenger_operation.h b/src/messenger/gnunet-service-messenger_operation.h deleted file mode 100644 index b93282d24..000000000 --- a/src/messenger/gnunet-service-messenger_operation.h +++ /dev/null | |||
@@ -1,130 +0,0 @@ | |||
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_util_lib.h" | ||
32 | #include "gnunet_scheduler_lib.h" | ||
33 | #include "gnunet_time_lib.h" | ||
34 | |||
35 | enum GNUNET_MESSENGER_OperationType | ||
36 | { | ||
37 | GNUNET_MESSENGER_OP_REQUEST = 1, | ||
38 | GNUNET_MESSENGER_OP_DELETE = 2, | ||
39 | GNUNET_MESSENGER_OP_MERGE = 3, | ||
40 | |||
41 | GNUNET_MESSENGER_OP_UNKNOWN = 0 | ||
42 | }; | ||
43 | |||
44 | struct GNUNET_MESSENGER_OperationStore; | ||
45 | |||
46 | struct GNUNET_MESSENGER_Operation | ||
47 | { | ||
48 | enum GNUNET_MESSENGER_OperationType type; | ||
49 | |||
50 | struct GNUNET_HashCode hash; | ||
51 | struct GNUNET_TIME_Absolute timestamp; | ||
52 | |||
53 | struct GNUNET_MESSENGER_OperationStore *store; | ||
54 | struct GNUNET_SCHEDULER_Task* task; | ||
55 | }; | ||
56 | |||
57 | /** | ||
58 | * Creates and allocates a new operation under a given <i>hash</i>. | ||
59 | * | ||
60 | * @param[in] hash Hash of message | ||
61 | */ | ||
62 | struct GNUNET_MESSENGER_Operation* | ||
63 | create_operation (const struct GNUNET_HashCode *hash); | ||
64 | |||
65 | /** | ||
66 | * Destroys an operation and frees its memory fully. | ||
67 | * | ||
68 | * @param[in,out] op Operation | ||
69 | */ | ||
70 | void | ||
71 | destroy_operation (struct GNUNET_MESSENGER_Operation *op); | ||
72 | |||
73 | /** | ||
74 | * Loads data from a configuration file at a selected <i>path</i> into | ||
75 | * a new allocated and created operation for a specific operation | ||
76 | * <i>store</i> if the required information could be read successfully. | ||
77 | * | ||
78 | * The method will return the new operation and it will be started | ||
79 | * automatically to match its timestamp of execution. | ||
80 | * | ||
81 | * If the method fails to restore any valid operation from the file, | ||
82 | * NULL gets returned instead. | ||
83 | * | ||
84 | * @param[in,out] store Operation store | ||
85 | * @param[in] path Path of a configuration file | ||
86 | */ | ||
87 | struct GNUNET_MESSENGER_Operation* | ||
88 | load_operation (struct GNUNET_MESSENGER_OperationStore *store, | ||
89 | 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, | ||
101 | const char *path); | ||
102 | |||
103 | /** | ||
104 | * Starts an inactive operation with a given <i>delay</i> in a | ||
105 | * specific operation <i>store</i>. The method will replace the | ||
106 | * operations type to process it correctly. An operation can't be | ||
107 | * started twice, it has to be stopped or fully processed first. | ||
108 | * | ||
109 | * @param[in,out] op Operation | ||
110 | * @param[in] type Type of operation | ||
111 | * @param[in,out] store Operation store | ||
112 | * @param[in] delay Delay | ||
113 | * @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR | ||
114 | */ | ||
115 | int | ||
116 | start_operation (struct GNUNET_MESSENGER_Operation *op, | ||
117 | enum GNUNET_MESSENGER_OperationType type, | ||
118 | struct GNUNET_MESSENGER_OperationStore *store, | ||
119 | struct GNUNET_TIME_Relative delay); | ||
120 | |||
121 | /** | ||
122 | * Stops an active operation and resets its type to be | ||
123 | * #GNUNET_MESSENGER_OP_UNKNOWN. | ||
124 | * | ||
125 | * @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR | ||
126 | */ | ||
127 | int | ||
128 | stop_operation (struct GNUNET_MESSENGER_Operation *op); | ||
129 | |||
130 | #endif //GNUNET_SERVICE_MESSENGER_OPERATION_H | ||