| 1 | /****************************************************************************** |
|---|
| 2 | * $Id: completion.h 2891 2007-08-21 15:17:02Z charles $ |
|---|
| 3 | * |
|---|
| 4 | * Copyright (c) 2005 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 | |
|---|
| 30 | typedef struct tr_completion_s tr_completion_t; |
|---|
| 31 | |
|---|
| 32 | tr_completion_t * tr_cpInit( tr_torrent_t * ); |
|---|
| 33 | void tr_cpClose( tr_completion_t * ); |
|---|
| 34 | void tr_cpReset( tr_completion_t * ); |
|---|
| 35 | |
|---|
| 36 | /* General */ |
|---|
| 37 | |
|---|
| 38 | cp_status_t tr_cpGetStatus ( const tr_completion_t * ); |
|---|
| 39 | uint64_t tr_cpDownloadedValid( const tr_completion_t * ); |
|---|
| 40 | uint64_t tr_cpLeftUntilComplete( const tr_completion_t * ); |
|---|
| 41 | uint64_t tr_cpLeftUntilDone( const tr_completion_t * ); |
|---|
| 42 | float tr_cpPercentComplete( const tr_completion_t * ); |
|---|
| 43 | float tr_cpPercentDone( const tr_completion_t * ); |
|---|
| 44 | void tr_cpInvalidateDND ( tr_completion_t * ); |
|---|
| 45 | |
|---|
| 46 | /* Pieces */ |
|---|
| 47 | int tr_cpPieceIsComplete( const tr_completion_t *, int piece ); |
|---|
| 48 | void tr_cpPieceAdd( tr_completion_t *, int piece ); |
|---|
| 49 | void tr_cpPieceRem( tr_completion_t *, int piece ); |
|---|
| 50 | |
|---|
| 51 | /* Blocks */ |
|---|
| 52 | void tr_cpDownloaderAdd( tr_completion_t *, int block ); |
|---|
| 53 | void tr_cpDownloaderRem( tr_completion_t *, int block ); |
|---|
| 54 | int tr_cpBlockIsComplete( const tr_completion_t *, int block ); |
|---|
| 55 | void tr_cpBlockAdd( tr_completion_t *, int block ); |
|---|
| 56 | void tr_cpBlockBitfieldSet( tr_completion_t *, struct tr_bitfield_s * ); |
|---|
| 57 | float tr_cpPercentBlocksInPiece( const tr_completion_t * cp, int piece ); |
|---|
| 58 | /* Missing = we don't have it and we are not getting it from any peer yet */ |
|---|
| 59 | int tr_cpMissingBlocksForPiece( const tr_completion_t * cp, int piece ); |
|---|
| 60 | int tr_cpMissingBlockInPiece( const tr_completion_t *, int piece ); |
|---|
| 61 | |
|---|
| 62 | const struct tr_bitfield_s * tr_cpPieceBitfield( const tr_completion_t* ); |
|---|
| 63 | const struct tr_bitfield_s * tr_cpBlockBitfield( const tr_completion_t * ); |
|---|
| 64 | |
|---|
| 65 | #endif |
|---|
