File: visitedlink_delegate.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 (84 lines) | stat: -rw-r--r-- 2,954 bytes parent folder | download | duplicates (6)
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
72
73
74
75
76
77
78
79
80
81
82
83
84
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_VISITEDLINK_BROWSER_VISITEDLINK_DELEGATE_H_
#define COMPONENTS_VISITEDLINK_BROWSER_VISITEDLINK_DELEGATE_H_

#include "base/memory/ref_counted.h"

class GURL;

namespace net {
class SchemefulSite;
}

namespace url {
class Origin;
}

namespace visitedlink {

// Delegate class that clients of VisitedLinkWriter must implement.
class VisitedLinkDelegate {
 public:
  // See VisitedLinkWriter::RebuildTable.
  class URLEnumerator : public base::RefCountedThreadSafe<URLEnumerator> {
   public:
    // Call this with each URL to rebuild the table.
    virtual void OnURL(const GURL& url) = 0;

    // This must be called by Delegate after RebuildTable is called. |success|
    // indicates all URLs have been returned successfully. The URLEnumerator
    // object cannot be used by the delegate after this call.
    virtual void OnComplete(bool success) = 0;

   protected:
    virtual ~URLEnumerator() = default;

   private:
    friend class base::RefCountedThreadSafe<URLEnumerator>;
  };

  class VisitedLinkEnumerator
      : public base::RefCountedThreadSafe<VisitedLinkEnumerator> {
   public:
    // Call this with each visited link to rebuild the table.
    virtual void OnVisitedLink(const GURL& link_url,
                               const net::SchemefulSite& top_level_site,
                               const url::Origin& frame_origin) = 0;

    // This must be called by Delegate after BuildVisitedLinkTable is called.
    // `success` indicates all visited links have been returned successfully.
    // The VisitedLinkEnumerator object cannot be used by the delegate after
    // this call.
    virtual void OnVisitedLinkComplete(bool success) = 0;

   protected:
    virtual ~VisitedLinkEnumerator() = default;

   private:
    friend class base::RefCountedThreadSafe<VisitedLinkEnumerator>;
  };

  // Delegate class is responsible for persisting the list of visited URLs
  // across browser runs. This is called by VisitedLinkWriter to repopulate
  // its internal table. Note that methods on enumerator can be called on any
  // thread but the delegate is responsible for synchronizating the calls.
  virtual void RebuildTable(const scoped_refptr<URLEnumerator>& enumerator) = 0;

  // Delegate class is responsible for persisting the list of partitioned
  // visited links across browser runs. This is called by
  // PartitionVisitedLinkWriter to repopulate its internal table. Note that
  // methods on enumerator can be called on any thread but the delegate is
  // responsible for synchronizating the calls.
  virtual void BuildVisitedLinkTable(
      const scoped_refptr<VisitedLinkEnumerator>& enumerator) = 0;

 protected:
  virtual ~VisitedLinkDelegate() = default;
};

}  // namespace visitedlink

#endif  // COMPONENTS_VISITEDLINK_BROWSER_VISITEDLINK_DELEGATE_H_