source: trunk/libtransmission/inout.h @ 6842

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

(libT) finish killing tr_errno.

  • Property svn:keywords set to Date Rev Author Id
File size: 2.6 KB
Line 
1/******************************************************************************
2 * $Id: inout.h 6842 2008-10-03 04:49:06Z 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_IO_H
26#define TR_IO_H 1
27
28struct tr_torrent;
29
30/**
31 * Reads the block specified by the piece index, offset, and length.
32 * @return 0 on success, or an errno value on failure.
33 */
34int tr_ioRead( const struct tr_torrent * tor,
35               tr_piece_index_t          pieceIndex,
36               uint32_t                  offset,
37               uint32_t                  len,
38               uint8_t *                 setme );
39
40/**
41 * Writes the block specified by the piece index, offset, and length.
42 * @return 0 on success, or an errno value on failure.
43 */
44int tr_ioWrite( const struct tr_torrent * tor,
45                tr_piece_index_t          pieceIndex,
46                uint32_t                  offset,
47                uint32_t                  len,
48                const uint8_t *           writeme );
49
50/**
51 * returns nonzero if the piece matches its metainfo's SHA1 checksum.
52 */
53int tr_ioTestPiece( const tr_torrent*,
54                    int   piece );
55
56
57/**
58 * Converts a piece index + offset into a file index + offset.
59 */
60void     tr_ioFindFileLocation( const tr_torrent * tor,
61                                tr_piece_index_t   pieceIndex,
62                                uint32_t           pieceOffset,
63                                tr_file_index_t *  fileIndex,
64                                uint64_t *         fileOffset );
65
66
67#endif
Note: See TracBrowser for help on using the repository browser.