source: trunk/libtransmission/inout.h @ 7151

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

(libT) add #ifdefs to ensure that client apps don't #include private libtransmission headers.

  • Property svn:keywords set to Date Rev Author Id
File size: 2.7 KB
Line 
1/******************************************************************************
2 * $Id: inout.h 7151 2008-11-24 20:17:36Z 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
32struct 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 */
38int 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 */
48int 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 * returns nonzero if the piece matches its metainfo's SHA1 checksum.
56 */
57int tr_ioTestPiece( const tr_torrent*,
58                    int   piece );
59
60
61/**
62 * Converts a piece index + offset into a file index + offset.
63 */
64void     tr_ioFindFileLocation( const tr_torrent * tor,
65                                tr_piece_index_t   pieceIndex,
66                                uint32_t           pieceOffset,
67                                tr_file_index_t *  fileIndex,
68                                uint64_t *         fileOffset );
69
70
71#endif
Note: See TracBrowser for help on using the repository browser.