File: shared_dictionary.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 (52 lines) | stat: -rw-r--r-- 1,970 bytes parent folder | download | duplicates (5)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef NET_SHARED_DICTIONARY_SHARED_DICTIONARY_H_
#define NET_SHARED_DICTIONARY_SHARED_DICTIONARY_H_

#include <string>

#include "base/functional/callback.h"
#include "base/memory/ref_counted.h"
#include "net/base/hash_value.h"
#include "net/base/net_export.h"

namespace net {
class IOBuffer;

// This class is used to read the binary of the shared dictionary.
class NET_EXPORT SharedDictionary : public base::RefCounted<SharedDictionary> {
 public:
  // Reads the whole binary of the dictionary. If an error has occurred, returns
  // ERR_FAILED. If the binary of the dictionary is already in the memory
  // returns OK. Otherwise returns ERR_IO_PENDING and `callback` will be called
  // asynchronously with OK or ERR_FAILED depending on the success status.
  virtual int ReadAll(base::OnceCallback<void(int)> callback) = 0;

  // Returns the buffer which contains the binary of the dictionary.
  // ReadAll() must have succeeded before calling this method.
  virtual scoped_refptr<IOBuffer> data() const = 0;

  // Returns the binary size of the dictionary. It is safe to call this method
  // before calling ReadAll().
  virtual size_t size() const = 0;

  // Returns the hash of the binary of the dictionary. It is safe to call this
  // method before calling ReadAll().
  virtual const SHA256HashValue& hash() const = 0;

  // Returns the server-provided id of the dictionary. When this id is not
  // empty, it will be serialized [RFC8941] and sent in "Dictionary-ID" request
  // when Chrome can use the dictionary.
  // https://www.rfc-editor.org/rfc/rfc8941#name-serializing-a-string
  virtual const std::string& id() const = 0;

 protected:
  friend class base::RefCounted<SharedDictionary>;
  virtual ~SharedDictionary() = default;
};

}  // namespace net

#endif  // NET_SHARED_DICTIONARY_SHARED_DICTIONARY_H_