aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJulius Bünger <buenger@mytum.de>2018-08-09 13:54:10 +0200
committerJulius Bünger <buenger@mytum.de>2018-08-09 13:54:47 +0200
commit9c164a60e4e3d6fadfd85cdd8d3def851c37d0de (patch)
tree06ba5ac5f173f10055dae585b4a72b397eda9e46 /src
parent8f6ad409fd2c25119453eab7b741428584fa8f80 (diff)
downloadgnunet-9c164a60e4e3d6fadfd85cdd8d3def851c37d0de.tar.gz
gnunet-9c164a60e4e3d6fadfd85cdd8d3def851c37d0de.zip
Add docstrings to recently introduced functions
Diffstat (limited to 'src')
-rw-r--r--src/rps/gnunet-service-rps.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/rps/gnunet-service-rps.c b/src/rps/gnunet-service-rps.c
index 21963ee42..d601ac7d4 100644
--- a/src/rps/gnunet-service-rps.c
+++ b/src/rps/gnunet-service-rps.c
@@ -1257,6 +1257,11 @@ Peers_get_channel_flag (const struct GNUNET_PeerIdentity *peer,
1257int 1257int
1258Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags); 1258Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
1259 1259
1260/**
1261 * @brief Callback for the scheduler to destroy the knowledge of a peer.
1262 *
1263 * @param cls Context of the peer
1264 */
1260static void 1265static void
1261destroy_peer (void *cls) 1266destroy_peer (void *cls)
1262{ 1267{
@@ -1271,6 +1276,13 @@ static void
1271destroy_channel (void *cls); 1276destroy_channel (void *cls);
1272 1277
1273 1278
1279/**
1280 * @brief Schedule the destruction of the given channel.
1281 *
1282 * Do so only if it was not already scheduled and not during shutdown.
1283 *
1284 * @param channel_ctx The context of the channel to destroy.
1285 */
1274static void 1286static void
1275schedule_channel_destruction (struct ChannelCtx *channel_ctx) 1287schedule_channel_destruction (struct ChannelCtx *channel_ctx)
1276{ 1288{
@@ -1284,6 +1296,13 @@ schedule_channel_destruction (struct ChannelCtx *channel_ctx)
1284} 1296}
1285 1297
1286 1298
1299/**
1300 * @brief Schedule the destruction of the given peer.
1301 *
1302 * Do so only if it was not already scheduled and not during shutdown.
1303 *
1304 * @param peer_ctx The context of the peer to destroy.
1305 */
1287static void 1306static void
1288schedule_peer_destruction (struct PeerContext *peer_ctx) 1307schedule_peer_destruction (struct PeerContext *peer_ctx)
1289{ 1308{
@@ -1678,6 +1697,11 @@ Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer)
1678 return GNUNET_NO; 1697 return GNUNET_NO;
1679} 1698}
1680 1699
1700/**
1701 * @brief Callback for scheduler to destroy a channel
1702 *
1703 * @param cls Context of the channel
1704 */
1681static void 1705static void
1682destroy_channel (void *cls) 1706destroy_channel (void *cls)
1683{ 1707{