source: trunk/libtransmission/webseed.h @ 7357

Last change on this file since 7357 was 7357, checked in by charles, 12 years ago

(libT) add some documentation about the three separate peer structs and how they are related.

  • Property svn:keywords set to Date Rev Author Id
File size: 1.4 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: webseed.h 7357 2008-12-11 17:02:34Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_WEBSEED_H
18#define TR_WEBSEED_H
19
20typedef struct tr_webseed tr_webseed;
21
22#include "peer-common.h"
23#include "publish.h"
24
25tr_webseed* tr_webseedNew( struct tr_torrent * torrent,
26                           const char *        url,
27                           tr_delivery_func    delivery_func,
28                           void *              delivery_userdata );
29
30void        tr_webseedFree( tr_webseed * );
31
32tr_addreq_t tr_webseedAddRequest( tr_webseed *     w,
33                                  uint32_t         index,
34                                  uint32_t         offset,
35                                  uint32_t         length );
36
37/** @return true if a request is being processed, or false if idle */
38int         tr_webseedGetSpeed( const tr_webseed * w,
39                                float *            setme_KiBs );
40
41/** @return true if a request is being processed, or false if idle */
42int         tr_webseedIsActive( const tr_webseed * w );
43
44
45#endif
Note: See TracBrowser for help on using the repository browser.