doip_message.h

Go to the documentation of this file.

/* Diagnostic Client library
 * Copyright (C) 2024  Avijit Dey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef DIAGNOSTIC_CLIENT_LIB_LIB_DOIP_CLIENT_COMMON_DOIP_MESSAGE_H
#define DIAGNOSTIC_CLIENT_LIB_LIB_DOIP_CLIENT_COMMON_DOIP_MESSAGE_H
 
#include <cstdint>
#include <string>
#include <string_view>
 
#include "core/include/span.h"
 
namespace doip_client {
class DoipMessage final {
 public:
  enum class MessageType : std::uint8_t { kUdp, kTcp };
 
  enum class RxSocketType : std::uint8_t { kBroadcast, kUnicast };
 
  using IpAddressType = std::string_view;
 
 public:
  DoipMessage(MessageType message_type, IpAddressType host_ip_address,
              std::uint16_t host_port_number, core_type::Span<std::uint8_t const> payload);
 
  DoipMessage(const DoipMessage &other) = default;
  DoipMessage(DoipMessage &&other) noexcept = default;
  DoipMessage &operator=(const DoipMessage &other) = default;
  DoipMessage &operator=(DoipMessage &&other) noexcept = default;
 
  ~DoipMessage() noexcept = default;
 
  IpAddressType GetHostIpAddress() const { return host_ip_address_; }
 
  std::uint16_t GetHostPortNumber() const { return host_port_number_; }
 
  std::uint8_t GetProtocolVersion() const { return protocol_version_; }
 
  std::uint8_t GetInverseProtocolVersion() const { return protocol_version_inv_; }
 
  std::uint16_t GetPayloadType() const { return payload_type_; }
 
  std::uint16_t GetServerAddress() const { return server_address_; }
 
  std::uint16_t GetClientAddress() const { return client_address_; }
 
  std::uint32_t GetPayloadLength() const { return payload_length_; }
 
  core_type::Span<std::uint8_t const> GetPayload() const { return payload_; }
 
 private:
  std::string host_ip_address_;
 
  std::uint16_t host_port_number_;
 
  std::uint8_t protocol_version_;
 
  std::uint8_t protocol_version_inv_;
 
  std::uint16_t server_address_;
 
  std::uint16_t client_address_;
 
  std::uint16_t payload_type_;
 
  std::uint32_t payload_length_;
 
  core_type::Span<std::uint8_t const> payload_;
};
}  // namespace doip_client
 
#endif  //DIAGNOSTIC_CLIENT_LIB_LIB_DOIP_CLIENT_COMMON_DOIP_MESSAGE_H