source: trunk/libtransmission/inout.h @ 11709

Last change on this file since 11709 was 11709, checked in by jordan, 10 years ago

Update the copyright year in the source code comments.

The Berne Convention says that the copyright year is moot, so instead of adding another year to each file as in previous years, I've removed the year altogether from the source code comments in libtransmission, gtk, qt, utils, daemon, and cli.

Juliusz's copyright notice in tr-dht and Johannes' copyright notice in tr-lpd have been left alone; it didn't seem appropriate to modify them.

  • Property svn:keywords set to Date Rev Author Id
File size: 2.0 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
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 11709 2011-01-19 13:48:47Z jordan $
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 */
56tr_bool tr_ioTestPiece( tr_torrent       * tor,
57                        tr_piece_index_t   piece );
58
59
60/**
61 * Converts a piece index + offset into a file index + offset.
62 */
63void     tr_ioFindFileLocation( const tr_torrent * tor,
64                                tr_piece_index_t   pieceIndex,
65                                uint32_t           pieceOffset,
66                                tr_file_index_t *  fileIndex,
67                                uint64_t *         fileOffset );
68
69
70/* @} */
71#endif
Note: See TracBrowser for help on using the repository browser.