paragraph for gnunet devs that don't know how to use the web
[oweals/gnunet.git] / src / fs / gnunet-service-fs_push.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2011 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
19 /**
20  * @file fs/gnunet-service-fs_push.h
21  * @brief support for pushing out content
22  * @author Christian Grothoff
23  */
24 #ifndef GNUNET_SERVICE_FS_PUSH_H
25 #define GNUNET_SERVICE_FS_PUSH_H
26
27 #include "gnunet-service-fs.h"
28
29
30 /**
31  * Setup the module.
32  */
33 void
34 GSF_push_init_ (void);
35
36
37 /**
38  * Shutdown the module.
39  */
40 void
41 GSF_push_done_ (void);
42
43
44 /**
45  * A peer connected to us or we are now again allowed to push content.
46  * Start pushing content to this peer.
47  *
48  * @param peer handle for the peer that connected
49  */
50 void
51 GSF_push_start_ (struct GSF_ConnectedPeer *peer);
52
53
54 /**
55  * A peer disconnected from us or asked us to stop pushing content for
56  * a while.  Stop pushing content to this peer.
57  *
58  * @param peer handle for the peer that disconnected
59  */
60 void
61 GSF_push_stop_ (struct GSF_ConnectedPeer *peer);
62
63
64 #endif