~george-edison55/twistload/trunk

« back to all changes in this revision

Viewing changes to src/fs/file.h

  • Committer: Nathan Osman
  • Date: 2017-07-20 18:47:17 UTC
  • Revision ID: git-v1:c064d311153d1e0c4d3193a383dc2d48ab3f5b08
Add filesystem classes File and AllocationTask.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * The MIT License (MIT)
 
3
 *
 
4
 * Copyright (c) 2017 Nathan Osman
 
5
 *
 
6
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 
7
 * of this software and associated documentation files (the "Software"), to
 
8
 * deal in the Software without restriction, including without limitation the
 
9
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 
10
 * sell copies of the Software, and to permit persons to whom the Software is
 
11
 * 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 DEALINGS
 
22
 * IN THE SOFTWARE.
 
23
 */
 
24
 
 
25
#ifndef FILE_H
 
26
#define FILE_H
 
27
 
 
28
#include <QFile>
 
29
#include <QObject>
 
30
#include <QThread>
 
31
 
 
32
class AllocationTask;
 
33
 
 
34
/**
 
35
 * @brief File supporting pre-allocation and random writes
 
36
 *
 
37
 * When downloading multiple parts of a file at the same time, a file object
 
38
 * capable of pre-allocating the required size and writing to random locations
 
39
 * within the file is required.
 
40
 */
 
41
class File : public QObject
 
42
{
 
43
    Q_OBJECT
 
44
 
 
45
public:
 
46
 
 
47
    /**
 
48
     * @brief Create a new file
 
49
     */
 
50
    explicit File(const QString &filename);
 
51
 
 
52
    /**
 
53
     * @brief Destroy the file object
 
54
     *
 
55
     * If allocation is in progress, this will block until the allocation
 
56
     * is successfully interrupted.
 
57
     */
 
58
    virtual ~File();
 
59
 
 
60
    /**
 
61
     * @brief Open the file for writing
 
62
     *
 
63
     * This method opens the file for writing and ensures that if size is
 
64
     * non-zero, empty data is written to the file to make it the requested
 
65
     * size. The finished() signal is emitted when this completes.
 
66
     */
 
67
    void open(qint64 size);
 
68
 
 
69
    /**
 
70
     * @brief Write data to the file at the specified location
 
71
     */
 
72
    bool write(const QByteArray &data, qint64 offset);
 
73
 
 
74
    /**
 
75
     * @brief Close the file
 
76
     */
 
77
    void close();
 
78
 
 
79
Q_SIGNALS:
 
80
 
 
81
    /**
 
82
     * @brief Indicate allocation progress
 
83
     * @param value integer between 0 and 100 inclusive
 
84
     */
 
85
    void allocationProgress(int value);
 
86
 
 
87
    /**
 
88
     * @brief Indicate an error occurred during allocation or writing
 
89
     */
 
90
    void allocationError(const QString &message);
 
91
 
 
92
    /**
 
93
     * @brief Indicate that the file has successfully been allocated
 
94
     *
 
95
     * The file will be open for writing.
 
96
     */
 
97
    void allocationSucceeded();
 
98
 
 
99
private Q_SLOTS:
 
100
 
 
101
    void onSucceeded();
 
102
 
 
103
private:
 
104
 
 
105
    QThread mThread;
 
106
    AllocationTask *mTask;
 
107
 
 
108
    QFile mFile;
 
109
};
 
110
 
 
111
#endif // FILE_H