source: trunk/libtransmission/inout.h @ 8561

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

(trunk libT) re-start work on making libT doxygen friendly. still a long ways to go on this.

  • Property svn:keywords set to Date Rev Author Id
File size: 2.2 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 8561 2009-05-29 19:17:12Z 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( const struct tr_torrent * tor,
32               tr_piece_index_t          pieceIndex,
33               uint32_t                  offset,
34               uint32_t                  len,
35               uint8_t *                 setme );
36
37/**
38 * Writes the block specified by the piece index, offset, and length.
39 * @return 0 on success, or an errno value on failure.
40 */
41int tr_ioWrite( const struct tr_torrent * tor,
42                tr_piece_index_t          pieceIndex,
43                uint32_t                  offset,
44                uint32_t                  len,
45                const uint8_t *           writeme );
46
47/**
48 * @brief Test to see if the piece matches its metainfo's SHA1 checksum.
49 *
50 * @param optionalBuffer if calling tr_ioTestPiece() repeatedly, you can
51 *                       get best performance by providing a buffer with
52 *                       tor->info.pieceSize bytes.
53 */
54tr_bool tr_ioTestPiece( const tr_torrent * tor,
55                        tr_piece_index_t   piece,
56                        void             * optionalBuffer,
57                        size_t             optionalBufferLen );
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.