OLD | NEW |
(Empty) | |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. |
| 4 |
| 5 #ifndef COMPONENTS_RAPPOR_RAPPOR_H_ |
| 6 #define COMPONENTS_RAPPOR_RAPPOR_H_ |
| 7 |
| 8 #include <string> |
| 9 |
| 10 #include "components/rappor/bloom_filter.h" |
| 11 #include "components/rappor/byte_vector_utils.h" |
| 12 #include "components/rappor/rappor_parameters.h" |
| 13 |
| 14 namespace rappor { |
| 15 |
| 16 // A RapporMetric is an object that collects string samples into a Bloom filter, |
| 17 // and generates randomized reports about the collected data. |
| 18 // |
| 19 // For a full description of the rappor metrics, see |
| 20 // http://www.chromium.org/developers/design-documents/rappor |
| 21 class RapporMetric { |
| 22 public: |
| 23 // Takes the |metric_name| that this will be reported to the server with, |
| 24 // a |parameters| describing size and probability weights to be used in |
| 25 // recording this metric, and cohort value, which modifies the hash |
| 26 // functions and used in the bloom filter. |
| 27 explicit RapporMetric(const std::string& metric_name, |
| 28 const RapporParameters& parameters, |
| 29 int32_t cohort); |
| 30 ~RapporMetric(); |
| 31 |
| 32 // Records an additional sample in the Bloom filter. |
| 33 void AddSample(const std::string& str); |
| 34 |
| 35 // Retrieves the current Bloom filter bits. |
| 36 const ByteVector& bytes() const { return bloom_filter_.bytes(); } |
| 37 |
| 38 // Gets the parameter values this metric was constructed with. |
| 39 const RapporParameters& parameters() const { return parameters_; } |
| 40 |
| 41 // Generates the bits to report for this metric. Using the secret as a seed, |
| 42 // randomly selects bits for redaction. Then flips coins to generate the |
| 43 // final report bits. |
| 44 ByteVector GetReport(const std::string& secret) const; |
| 45 |
| 46 private: |
| 47 const std::string metric_name_; |
| 48 const RapporParameters parameters_; |
| 49 BloomFilter bloom_filter_; |
| 50 |
| 51 DISALLOW_COPY_AND_ASSIGN(RapporMetric); |
| 52 }; |
| 53 |
| 54 } // namespace rappor |
| 55 |
| 56 #endif // COMPONENTS_RAPPOR_RAPPOR_H_ |
OLD | NEW |