source: trunk/libtransmission/completion.h @ 6840

Last change on this file since 6840 was 6840, checked in by charles, 14 years ago

(libT) eliminating tr_errno, part 3: don't use it in tr_cpBlockBitfieldSet()

  • Property svn:keywords set to Date Rev Author Id
File size: 3.7 KB
Line 
1/******************************************************************************
2 * $Id: completion.h 6840 2008-10-02 23:37:58Z 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#include "transmission.h"
29
30struct tr_bitfield;
31typedef struct tr_completion tr_completion;
32
33tr_completion *            tr_cpInit( tr_torrent * );
34
35void                       tr_cpClose( tr_completion * );
36
37/* General */
38
39cp_status_t                tr_cpGetStatus( const tr_completion * );
40
41uint64_t                   tr_cpHaveTotal( const tr_completion * );
42
43uint64_t                   tr_cpHaveValid( const tr_completion * );
44
45uint64_t                   tr_cpLeftUntilComplete( const tr_completion * );
46
47uint64_t                   tr_cpLeftUntilDone( const tr_completion * );
48
49uint64_t                   tr_cpSizeWhenDone( const tr_completion * );
50
51float                      tr_cpPercentComplete( const tr_completion * );
52
53float                      tr_cpPercentDone( const tr_completion * );
54
55void                       tr_cpInvalidateDND( tr_completion * );
56
57void                       tr_cpGetAmountDone( const   tr_completion * completion,
58                                               float                 * tab,
59                                               int                     tabCount );
60
61/* Pieces */
62int                        tr_cpPieceIsComplete( const tr_completion * completion,
63                                                 tr_piece_index_t      piece );
64
65void                       tr_cpPieceAdd( tr_completion    * completion,
66                                          tr_piece_index_t   piece );
67
68void                       tr_cpPieceRem( tr_completion     * completion,
69                                           tr_piece_index_t   piece );
70
71/* Blocks */
72int                        tr_cpBlockIsComplete( const tr_completion * completion,
73                                                 tr_block_index_t block );
74
75void                       tr_cpBlockAdd( tr_completion * completion,
76                                          tr_block_index_t block );
77
78int                        tr_cpBlockBitfieldSet( tr_completion      * completion,
79                                                  struct tr_bitfield * blocks );
80
81int                        tr_cpMissingBlocksInPiece( const tr_completion  * completion,
82                                                      tr_piece_index_t       piece );
83
84
85const struct tr_bitfield * tr_cpPieceBitfield( const tr_completion* );
86
87const struct tr_bitfield * tr_cpBlockBitfield( const tr_completion * );
88
89#endif
Note: See TracBrowser for help on using the repository browser.