aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/gnunet-service-messenger_tunnel.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_tunnel.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_tunnel.h')
-rw-r--r--src/messenger/gnunet-service-messenger_tunnel.h26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/messenger/gnunet-service-messenger_tunnel.h b/src/messenger/gnunet-service-messenger_tunnel.h
index 7bd749281..13cf924f9 100644
--- a/src/messenger/gnunet-service-messenger_tunnel.h
+++ b/src/messenger/gnunet-service-messenger_tunnel.h
@@ -50,7 +50,7 @@ struct GNUNET_MESSENGER_SrvTunnel
50/** 50/**
51 * Creates and allocates a tunnel of a <i>room</i> to a specific peer identity (called <i>door</i>). 51 * Creates and allocates a tunnel of a <i>room</i> to a specific peer identity (called <i>door</i>).
52 * 52 *
53 * @param[in/out] room Room 53 * @param[in,out] room Room
54 * @param[in] door Peer identity 54 * @param[in] door Peer identity
55 * @return New tunnel 55 * @return New tunnel
56 */ 56 */
@@ -61,7 +61,7 @@ create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room,
61/** 61/**
62 * Destroys a <i>tunnel</i> and frees its memory fully. 62 * Destroys a <i>tunnel</i> and frees its memory fully.
63 * 63 *
64 * @param[in/out] tunnel 64 * @param[in,out] tunnel
65 */ 65 */
66void 66void
67destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); 67destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
@@ -70,8 +70,8 @@ destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
70 * Binds a CADET <i>channel</i> to a <i>tunnel</i> and replaces its channel 70 * Binds a CADET <i>channel</i> to a <i>tunnel</i> and replaces its channel
71 * the tunnel is currently bound to if necessary. 71 * the tunnel is currently bound to if necessary.
72 * 72 *
73 * @param[in/out] tunnel Tunnel 73 * @param[in,out] tunnel Tunnel
74 * @param[in/out] channel CADET channel 74 * @param[in,out] channel CADET channel
75 */ 75 */
76void 76void
77bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, 77bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
@@ -81,7 +81,7 @@ bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
81 * Tries to connect a <i>tunnel</i> by creating a new CADET channel and binding it. 81 * Tries to connect a <i>tunnel</i> by creating a new CADET channel and binding it.
82 * The function returns #GNUNET_YES on success, otherwise #GNUNET_NO. 82 * The function returns #GNUNET_YES on success, otherwise #GNUNET_NO.
83 * 83 *
84 * @param[in/out] tunnel Tunnel 84 * @param[in,out] tunnel Tunnel
85 * @return #GNUNET_YES on success, otherwise #GNUNET_NO 85 * @return #GNUNET_YES on success, otherwise #GNUNET_NO
86 */ 86 */
87int 87int
@@ -91,7 +91,7 @@ connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
91 * Disconnects and unbinds a channel from a <i>tunnel</i>. The actual disconnection 91 * Disconnects and unbinds a channel from a <i>tunnel</i>. The actual disconnection
92 * will be asynchronous. 92 * will be asynchronous.
93 * 93 *
94 * @param[in/out] tunnel Tunnel 94 * @param[in,out] tunnel Tunnel
95 */ 95 */
96void 96void
97disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); 97disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
@@ -109,8 +109,8 @@ is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel);
109 * Sends an envelope containing a <i>message</i> with a given <i>hash</i> through 109 * Sends an envelope containing a <i>message</i> with a given <i>hash</i> through
110 * a <i>tunnel</i>. 110 * a <i>tunnel</i>.
111 * 111 *
112 * @param[in/out] tunnel Tunnel 112 * @param[in,out] tunnel Tunnel
113 * @param[in/out] env Envelope 113 * @param[in,out] env Envelope
114 * @param[in] hash Hash of message 114 * @param[in] hash Hash of message
115 */ 115 */
116void 116void
@@ -123,9 +123,9 @@ send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
123 * through the <i>tunnel</i>. The used <i>handle</i> will sign the message and 123 * through the <i>tunnel</i>. The used <i>handle</i> will sign the message and
124 * the <i>hash</i> will be calculated and stored. 124 * the <i>hash</i> will be calculated and stored.
125 * 125 *
126 * @param[in/out] tunnel Tunnel 126 * @param[in,out] tunnel Tunnel
127 * @param[in/out] handle Handle 127 * @param[in,out] handle Handle
128 * @param[in/out] message Message 128 * @param[in,out] message Message
129 * @return #GNUNET_YES on success, GNUNET_NO otherwise 129 * @return #GNUNET_YES on success, GNUNET_NO otherwise
130 */ 130 */
131int 131int
@@ -136,7 +136,7 @@ send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
136/** 136/**
137 * Forwards a given <i>message</i> with a known <i>hash</i> through a <i>tunnel</i>. 137 * Forwards a given <i>message</i> with a known <i>hash</i> through a <i>tunnel</i>.
138 * 138 *
139 * @param[in/out] tunnel Tunnel 139 * @param[in,out] tunnel Tunnel
140 * @param[in] message Message 140 * @param[in] message Message
141 * @param[in] hash Hash of message 141 * @param[in] hash Hash of message
142 */ 142 */
@@ -184,7 +184,7 @@ get_tunnel_messenger_version (const struct GNUNET_MESSENGER_SrvTunnel *tunnel);
184 * it is compatible to the running peer of the service. Depending on success it 184 * it is compatible to the running peer of the service. Depending on success it
185 * returns #GNUNET_OK or #GNUNET_SYSERR on failure. 185 * returns #GNUNET_OK or #GNUNET_SYSERR on failure.
186 * 186 *
187 * @param[in/out] tunnel Tunnel 187 * @param[in,out] tunnel Tunnel
188 * @param[in] version Version of messenger 188 * @param[in] version Version of messenger
189 */ 189 */
190int 190int