Program Listing for File service_info.hpp

Return to documentation for file (include/email/service_info.hpp)

// Copyright 2021 Christophe Bedard
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef EMAIL__SERVICE_INFO_HPP_
#define EMAIL__SERVICE_INFO_HPP_

#include <optional>  // NOLINT cpplint mistakes <optional> for a C system header

#include "email/communication_info.hpp"
#include "email/email/info.hpp"
#include "email/gid.hpp"
#include "email/timestamp.hpp"
#include "email/visibility_control.hpp"

namespace email
{

typedef int64_t SequenceNumber;


class ServiceInfo
{
public:
  EMAIL_PUBLIC
  ServiceInfo(
    const Timestamp & source_timestamp,
    const Timestamp & received_timestamp,
    const Gid & client_gid,
    const SequenceNumber sequence_number);

  EMAIL_PUBLIC
  ServiceInfo(const ServiceInfo &) = default;

  EMAIL_PUBLIC
  ~ServiceInfo();

  EMAIL_PUBLIC
  const Timestamp &
  source_timestamp() const;

  EMAIL_PUBLIC
  const Timestamp &
  received_timestamp() const;

  EMAIL_PUBLIC
  const Gid &
  client_gid() const;

  EMAIL_PUBLIC
  SequenceNumber
  sequence_number() const;


  static
  std::optional<ServiceInfo>
  from_headers(const EmailHeaders & headers);

  static constexpr auto HEADER_CLIENT_GID = "Client-GID";

private:
  const CommunicationInfo base_info_;
  const SequenceNumber sequence_number_;
};

}  // namespace email

#endif  // EMAIL__SERVICE_INFO_HPP_