quiche/common/internet_checksum.h

// Copyright (c) 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// WARNING: this file is a part of the QUICHE API that is publicly available and
// may be used by code that is not covered by QUICHE presubmits. Please run a
// global presubmit before making breaking changes.

#ifndef QUICHE_COMMON_INTERNET_CHECKSUM_H_
#define QUICHE_COMMON_INTERNET_CHECKSUM_H_

#include <cstddef>
#include <cstdint>

#include "absl/strings/string_view.h"
#include "absl/types/span.h"
#include "quiche/common/platform/api/quiche_export.h"

namespace quiche {

// Incrementally compute an Internet header checksum as described in RFC 1071.
class QUICHE_EXPORT InternetChecksum {
 public:
  // Update the checksum with the specified data.  Note that while the checksum
  // is commutative, the data has to be supplied in the units of two-byte words.
  // If there is an extra byte at the end, the function has to be called on it
  // last.
  void Update(const char* data, size_t size);
  void Update(const uint8_t* data, size_t size);
  void Update(absl::string_view data);
  void Update(absl::Span<const uint8_t> data);

  uint16_t Value() const;

 private:
  uint32_t accumulator_ = 0;
};

}  // namespace quiche

#endif  // QUICHE_COMMON_INTERNET_CHECKSUM_H_