File: open_file_handle.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (71 lines) | stat: -rw-r--r-- 2,431 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef STORAGE_BROWSER_FILE_SYSTEM_QUOTA_OPEN_FILE_HANDLE_H_
#define STORAGE_BROWSER_FILE_SYSTEM_QUOTA_OPEN_FILE_HANDLE_H_

#include <stdint.h>

#include "base/component_export.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"

namespace base {
class FilePath;
}

namespace storage {

class QuotaReservation;
class OpenFileHandleContext;
class QuotaReservationBuffer;

// Represents an open file like a file descriptor.
// This should be alive while a consumer keeps a file opened and should be
// deleted when the plugin closes the file.
class COMPONENT_EXPORT(STORAGE_BROWSER) OpenFileHandle {
 public:
  OpenFileHandle(const OpenFileHandle&) = delete;
  OpenFileHandle& operator=(const OpenFileHandle&) = delete;

  ~OpenFileHandle();

  // Updates cached file size and consumes quota for that.
  // Both this and AddAppendModeWriteAmount should be called for each modified
  // file before calling QuotaReservation::RefreshQuota and before closing the
  // file.
  void UpdateMaxWrittenOffset(int64_t offset);

  // Notifies that |amount| of data is written to the file in append mode, and
  // consumes quota for that.
  // Both this and UpdateMaxWrittenOffset should be called for each modified
  // file before calling QuotaReservation::RefreshQuota and before closing the
  // file.
  void AddAppendModeWriteAmount(int64_t amount);

  // Returns the estimated file size for the quota consumption calculation.
  // The client must consume its reserved quota when it writes data to the file
  // beyond the estimated file size.
  // The estimated file size is greater than or equal to actual file size after
  // all clients report their file usage,  and is monotonically increasing over
  // OpenFileHandle object life cycle, so that client may cache the value.
  int64_t GetEstimatedFileSize() const;

  int64_t GetMaxWrittenOffset() const;
  const base::FilePath& platform_path() const;

 private:
  friend class QuotaReservationBuffer;

  OpenFileHandle(QuotaReservation* reservation, OpenFileHandleContext* context);

  scoped_refptr<QuotaReservation> reservation_;
  scoped_refptr<OpenFileHandleContext> context_;

  SEQUENCE_CHECKER(sequence_checker_);
};

}  // namespace storage

#endif  // STORAGE_BROWSER_FILE_SYSTEM_QUOTA_OPEN_FILE_HANDLE_H_