source: trunk/libtransmission/completion.h @ 7576

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

(trunk libT) add "inline" hint to several one-liner functions

  • Property svn:keywords set to Date Rev Author Id
File size: 3.8 KB
Line 
1/******************************************************************************
2 * $Id: completion.h 7576 2009-01-02 06:28:22Z charles $
3 *
4 * Copyright (c) 2005-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#ifndef TR_COMPLETION_H
26#define TR_COMPLETION_H
27
28#ifndef __TRANSMISSION__
29#error only libtransmission should #include this header.
30#endif
31
32#include "transmission.h"
33
34struct tr_bitfield;
35typedef struct tr_completion tr_completion;
36
37tr_completion *            tr_cpInit( tr_torrent * );
38
39void                       tr_cpClose( tr_completion * );
40
41/* General */
42
43tr_completeness            tr_cpGetStatus( const tr_completion * );
44
45extern inline uint64_t     tr_cpHaveTotal( const tr_completion * );
46
47uint64_t                   tr_cpHaveValid( const tr_completion * );
48
49extern inline uint64_t     tr_cpLeftUntilComplete( const tr_completion * );
50
51extern inline uint64_t     tr_cpLeftUntilDone( const tr_completion * );
52
53uint64_t                   tr_cpSizeWhenDone( const tr_completion * );
54
55extern inline float        tr_cpPercentComplete( const tr_completion * );
56
57extern inline float        tr_cpPercentDone( const tr_completion * );
58
59void                       tr_cpInvalidateDND( tr_completion * );
60
61void                       tr_cpGetAmountDone( const   tr_completion * completion,
62                                               float                 * tab,
63                                               int                     tabCount );
64
65/* Pieces */
66extern inline int          tr_cpPieceIsComplete( const tr_completion * completion,
67                                                 tr_piece_index_t      piece );
68
69void                       tr_cpPieceAdd( tr_completion    * completion,
70                                          tr_piece_index_t   piece );
71
72void                       tr_cpPieceRem( tr_completion     * completion,
73                                           tr_piece_index_t   piece );
74
75/* Blocks */
76extern inline int          tr_cpBlockIsComplete( const tr_completion * completion,
77                                                 tr_block_index_t block );
78
79void                       tr_cpBlockAdd( tr_completion * completion,
80                                          tr_block_index_t block );
81
82int                        tr_cpBlockBitfieldSet( tr_completion      * completion,
83                                                  struct tr_bitfield * blocks );
84
85extern inline int          tr_cpMissingBlocksInPiece( const tr_completion  * completion,
86                                                      tr_piece_index_t       piece );
87
88
89extern inline const struct tr_bitfield *
90                           tr_cpPieceBitfield( const tr_completion* );
91
92extern inline const struct tr_bitfield *
93                           tr_cpBlockBitfield( const tr_completion * );
94
95#endif
Note: See TracBrowser for help on using the repository browser.