source: trunk/libtransmission/inout.h @ 9495

Last change on this file since 9495 was 9495, checked in by charles, 11 years ago

(trunk libT) #2551 "better buffer cache management": apply jch's prefetch-base.patch

  • Property svn:keywords set to Date Rev Author Id
File size: 2.3 KB
Line 
1/*
2 * This file Copyright (C) 2008-2009 Charles Kerr <charles@transmissionbt.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: inout.h 9495 2009-11-08 23:43:38Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14 #error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_IO_H
18#define TR_IO_H 1
19
20struct tr_torrent;
21
22/**
23 * @addtogroup file_io File IO
24 * @{
25 */
26
27/**
28 * Reads the block specified by the piece index, offset, and length.
29 * @return 0 on success, or an errno value on failure.
30 */
31int tr_ioRead( struct tr_torrent   * tor,
32               tr_piece_index_t      pieceIndex,
33               uint32_t              offset,
34               uint32_t              len,
35               uint8_t             * setme );
36
37int
38tr_ioPrefetch( tr_torrent       * tor,
39               tr_piece_index_t   pieceIndex,
40               uint32_t           begin,
41               uint32_t           len );
42
43/**
44 * Writes the block specified by the piece index, offset, and length.
45 * @return 0 on success, or an errno value on failure.
46 */
47int tr_ioWrite( struct tr_torrent  * tor,
48                tr_piece_index_t     pieceIndex,
49                uint32_t             offset,
50                uint32_t             len,
51                const uint8_t      * writeme );
52
53/**
54 * @brief Test to see if the piece matches its metainfo's SHA1 checksum.
55 *
56 * @param optionalBuffer if calling tr_ioTestPiece() repeatedly, you can
57 *                       get best performance by providing a buffer with
58 *                       tor->info.pieceSize bytes.
59 */
60tr_bool tr_ioTestPiece( tr_torrent       * tor,
61                        tr_piece_index_t   piece,
62                        void             * optionalBuffer,
63                        size_t             optionalBufferLen );
64
65
66/**
67 * Converts a piece index + offset into a file index + offset.
68 */
69void     tr_ioFindFileLocation( const tr_torrent * tor,
70                                tr_piece_index_t   pieceIndex,
71                                uint32_t           pieceOffset,
72                                tr_file_index_t *  fileIndex,
73                                uint64_t *         fileOffset );
74
75
76/* @} */
77#endif
Note: See TracBrowser for help on using the repository browser.