File: invalidation_handler.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 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 (51 lines) | stat: -rw-r--r-- 2,056 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
// Copyright 2014 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_INVALIDATION_PUBLIC_INVALIDATION_HANDLER_H_
#define COMPONENTS_INVALIDATION_PUBLIC_INVALIDATION_HANDLER_H_

#include <string>

#include "base/observer_list_types.h"
#include "components/invalidation/public/invalidation_export.h"
#include "components/invalidation/public/invalidation_util.h"
#include "components/invalidation/public/invalidator_state.h"

namespace invalidation {

class Invalidation;

class INVALIDATION_EXPORT InvalidationHandler : public base::CheckedObserver {
 public:
  InvalidationHandler() = default;
  InvalidationHandler(const InvalidationHandler& other) = delete;
  InvalidationHandler& operator=(const InvalidationHandler& other) = delete;
  ~InvalidationHandler() override;

  // Called when the invalidator state changes.
  virtual void OnInvalidatorStateChange(InvalidatorState state) = 0;

  // Called when the client has successfully subscribed to invalidations for
  // `topic`. This can be relevant for invalidation handlers because
  // invalidations published before the client has subscribed to the
  // corresponding topic will not be delivered. This can be called multiple
  // times because the subscription may need to be re-created in rare cases.
  // Child classes should override this if they're interested in this
  // notification - the default implementation does nothing.
  virtual void OnSuccessfullySubscribed(const Topic& invalidation) {}

  // Called when an invalidation is received. Note that this may be called
  // regardless of the current invalidator state.
  virtual void OnIncomingInvalidation(const Invalidation& invalidation) = 0;

  // Returned value must be unique for the handlers using the same invalidation
  // service.
  virtual std::string GetOwnerName() const = 0;

  virtual bool IsPublicTopic(const Topic& topic) const;
};

}  // namespace invalidation

#endif  // COMPONENTS_INVALIDATION_PUBLIC_INVALIDATION_HANDLER_H_