aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/gnunet-service-messenger_handle.h
diff options
context:
space:
mode:
authorWillow Liquorice <willow@howhill.com>2022-09-07 20:44:52 +0100
committerWillow Liquorice <willow@howhill.com>2022-10-03 00:44:34 +0100
commitdd797c2c6c01520fa73b1fd335ccd42df86b1b4d (patch)
tree1f508fa523fa7c3400fbd4f95a344d7f44ce37c1 /src/messenger/gnunet-service-messenger_handle.h
parent1d0bbddfefaefb6e3f5cd240e56462a6bef2fa09 (diff)
downloadgnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.tar.gz
gnunet-dd797c2c6c01520fa73b1fd335ccd42df86b1b4d.zip
-DOC: Documentation cleanup pass through MESSENGER subsystem
Diffstat (limited to 'src/messenger/gnunet-service-messenger_handle.h')
-rw-r--r--src/messenger/gnunet-service-messenger_handle.h26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/messenger/gnunet-service-messenger_handle.h b/src/messenger/gnunet-service-messenger_handle.h
index 8754716e9..c596f4d3b 100644
--- a/src/messenger/gnunet-service-messenger_handle.h
+++ b/src/messenger/gnunet-service-messenger_handle.h
@@ -55,8 +55,8 @@ struct GNUNET_MESSENGER_SrvHandle
55/** 55/**
56 * Creates and allocates a new handle related to a <i>service</i> and using a given <i>mq</i> (message queue). 56 * Creates and allocates a new handle related to a <i>service</i> and using a given <i>mq</i> (message queue).
57 * 57 *
58 * @param[in/out] service MESSENGER Service 58 * @param[in,out] service MESSENGER Service
59 * @param[in/out] mq Message queue 59 * @param[in,out] mq Message queue
60 * @return New handle 60 * @return New handle
61 */ 61 */
62struct GNUNET_MESSENGER_SrvHandle* 62struct GNUNET_MESSENGER_SrvHandle*
@@ -66,7 +66,7 @@ create_srv_handle (struct GNUNET_MESSENGER_Service *service,
66/** 66/**
67 * Destroys a handle and frees its memory fully. 67 * Destroys a handle and frees its memory fully.
68 * 68 *
69 * @param[in/out] handle Handle 69 * @param[in,out] handle Handle
70 */ 70 */
71void 71void
72destroy_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle); 72destroy_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle);
@@ -103,7 +103,7 @@ get_srv_handle_member_id (const struct GNUNET_MESSENGER_SrvHandle *handle,
103 * 103 *
104 * The client connected to the <i>handle</i> will be informed afterwards automatically. 104 * The client connected to the <i>handle</i> will be informed afterwards automatically.
105 * 105 *
106 * @param[in/out] handle Handle 106 * @param[in,out] handle Handle
107 * @param[in] key Key of a room 107 * @param[in] key Key of a room
108 * @param[in] unique_id Unique member id 108 * @param[in] unique_id Unique member id
109 * @return GNUNET_OK on success, otherwise GNUNET_SYSERR 109 * @return GNUNET_OK on success, otherwise GNUNET_SYSERR
@@ -116,7 +116,7 @@ change_srv_handle_member_id (struct GNUNET_MESSENGER_SrvHandle *handle,
116/** 116/**
117 * Sets the EGO used by a given <i>handle</i>. 117 * Sets the EGO used by a given <i>handle</i>.
118 * 118 *
119 * @param[in/out] handle Handle 119 * @param[in,out] handle Handle
120 * @param[in] ego EGO key pair 120 * @param[in] ego EGO key pair
121 */ 121 */
122void 122void
@@ -135,7 +135,7 @@ get_srv_handle_ego (const struct GNUNET_MESSENGER_SrvHandle *handle);
135/** 135/**
136 * Tries to set the name and EGO key of a <i>handle</i> initially by looking up a specific <i>name</i>. 136 * Tries to set the name and EGO key of a <i>handle</i> initially by looking up a specific <i>name</i>.
137 * 137 *
138 * @param[in/out] handle Handle 138 * @param[in,out] handle Handle
139 * @param[in] name Name (optionally: valid EGO name) 139 * @param[in] name Name (optionally: valid EGO name)
140 */ 140 */
141void 141void
@@ -146,7 +146,7 @@ setup_srv_handle_name (struct GNUNET_MESSENGER_SrvHandle *handle,
146 * Tries to change the key pair of an EGO of a <i>handle</i> under the same name and informs all rooms 146 * Tries to change the key pair of an EGO of a <i>handle</i> under the same name and informs all rooms
147 * about the change automatically. 147 * about the change automatically.
148 * 148 *
149 * @param[in/out] handle Handle 149 * @param[in,out] handle Handle
150 */ 150 */
151void 151void
152update_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle); 152update_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle);
@@ -157,7 +157,7 @@ update_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle);
157 * 157 *
158 * The client connected to the <i>handle</i> will be informed afterwards automatically. 158 * The client connected to the <i>handle</i> will be informed afterwards automatically.
159 * 159 *
160 * @param[in/out] handle Handle 160 * @param[in,out] handle Handle
161 * @param[in] name New name 161 * @param[in] name New name
162 */ 162 */
163void 163void
@@ -168,7 +168,7 @@ set_srv_handle_name (struct GNUNET_MESSENGER_SrvHandle *handle,
168 * Makes a given <i>handle</i> a member of the room using a specific <i>key</i> and opens the 168 * Makes a given <i>handle</i> a member of the room using a specific <i>key</i> and opens the
169 * room from the handles service. 169 * room from the handles service.
170 * 170 *
171 * @param[in/out] handle Handle 171 * @param[in,out] handle Handle
172 * @param[in] key Key of a room 172 * @param[in] key Key of a room
173 * @return #GNUNET_YES on success, otherwise #GNUNET_NO 173 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
174 */ 174 */
@@ -180,7 +180,7 @@ open_srv_handle_room (struct GNUNET_MESSENGER_SrvHandle *handle,
180 * Makes a given <i>handle</i> a member of the room using a specific <i>key</i> and enters the room 180 * Makes a given <i>handle</i> a member of the room using a specific <i>key</i> and enters the room
181 * through a tunnel to a peer identified by a given <i>door</i> (peer identity). 181 * through a tunnel to a peer identified by a given <i>door</i> (peer identity).
182 * 182 *
183 * @param[in/out] handle Handle 183 * @param[in,out] handle Handle
184 * @param[in] door Peer identity 184 * @param[in] door Peer identity
185 * @param[in] key Key of a room 185 * @param[in] key Key of a room
186 * @return #GNUNET_YES on success, otherwise #GNUNET_NO 186 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
@@ -194,7 +194,7 @@ entry_srv_handle_room (struct GNUNET_MESSENGER_SrvHandle *handle,
194 * Removes the membership of the room using a specific <i>key</i> and closes it if no other handle 194 * Removes the membership of the room using a specific <i>key</i> and closes it if no other handle
195 * from this service is still a member of it. 195 * from this service is still a member of it.
196 * 196 *
197 * @param[in/out] handle Handle 197 * @param[in,out] handle Handle
198 * @param[in] key Key of a room 198 * @param[in] key Key of a room
199 * @return #GNUNET_YES on success, otherwise #GNUNET_NO 199 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
200 */ 200 */
@@ -205,7 +205,7 @@ close_srv_handle_room (struct GNUNET_MESSENGER_SrvHandle *handle,
205/** 205/**
206 * Sends a <i>message</i> from a given <i>handle</i> to the room using a specific <i>key</i>. 206 * Sends a <i>message</i> from a given <i>handle</i> to the room using a specific <i>key</i>.
207 * 207 *
208 * @param[in/out] handle Handle 208 * @param[in,out] handle Handle
209 * @param[in] key Key of a room 209 * @param[in] key Key of a room
210 * @param[in] message Message 210 * @param[in] message Message
211 * @return #GNUNET_YES on success, #GNUNET_NO or #GNUNET_SYSERR otherwise. 211 * @return #GNUNET_YES on success, #GNUNET_NO or #GNUNET_SYSERR otherwise.
@@ -218,7 +218,7 @@ send_srv_handle_message (struct GNUNET_MESSENGER_SrvHandle *handle,
218/** 218/**
219 * Notifies the handle that a new message was received or sent. 219 * Notifies the handle that a new message was received or sent.
220 * 220 *
221 * @param[in/out] handle Handle 221 * @param[in,out] handle Handle
222 * @param[in] room Room of the message 222 * @param[in] room Room of the message
223 * @param[in] session Member session 223 * @param[in] session Member session
224 * @param[in] message Message 224 * @param[in] message Message