1 | /****************************************************************************** |
---|
2 | * $Id: inout.h 7559 2008-12-31 18:08:13Z 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 __TRANSMISSION__ |
---|
26 | #error only libtransmission should #include this header. |
---|
27 | #endif |
---|
28 | |
---|
29 | #ifndef TR_IO_H |
---|
30 | #define TR_IO_H 1 |
---|
31 | |
---|
32 | struct tr_torrent; |
---|
33 | |
---|
34 | /** |
---|
35 | * Reads the block specified by the piece index, offset, and length. |
---|
36 | * @return 0 on success, or an errno value on failure. |
---|
37 | */ |
---|
38 | int tr_ioRead( const struct tr_torrent * tor, |
---|
39 | tr_piece_index_t pieceIndex, |
---|
40 | uint32_t offset, |
---|
41 | uint32_t len, |
---|
42 | uint8_t * setme ); |
---|
43 | |
---|
44 | /** |
---|
45 | * Writes the block specified by the piece index, offset, and length. |
---|
46 | * @return 0 on success, or an errno value on failure. |
---|
47 | */ |
---|
48 | int tr_ioWrite( const struct tr_torrent * tor, |
---|
49 | tr_piece_index_t pieceIndex, |
---|
50 | uint32_t offset, |
---|
51 | uint32_t len, |
---|
52 | const uint8_t * writeme ); |
---|
53 | |
---|
54 | /** |
---|
55 | * @brief Test to see if the piece matches its metainfo's SHA1 checksum. |
---|
56 | * |
---|
57 | * @param optionalBuffer if calling tr_ioTestPiece() repeatedly, you can |
---|
58 | * get best performance by providing a buffer with |
---|
59 | * tor->info.pieceSize bytes. |
---|
60 | */ |
---|
61 | tr_bool tr_ioTestPiece( const tr_torrent * tor, |
---|
62 | tr_piece_index_t piece, |
---|
63 | void * optionalBuffer, |
---|
64 | size_t optionalBufferLen ); |
---|
65 | |
---|
66 | |
---|
67 | /** |
---|
68 | * Converts a piece index + offset into a file index + offset. |
---|
69 | */ |
---|
70 | void tr_ioFindFileLocation( const tr_torrent * tor, |
---|
71 | tr_piece_index_t pieceIndex, |
---|
72 | uint32_t pieceOffset, |
---|
73 | tr_file_index_t * fileIndex, |
---|
74 | uint64_t * fileOffset ); |
---|
75 | |
---|
76 | |
---|
77 | #endif |
---|