uds_transport::UdsMessage Class Reference

#include <uds_message.h>

Inheritance diagram for uds_transport::UdsMessage:

Public Types
enum class	TargetAddressType : std::uint8_t { kPhysical = 0U , kFunctional = 1U }
using	Address = std::uint16_t
using	IpAddress = std::string_view
using	PortNumber = std::uint16_t
using	MetaInfoMap = std::map< std::string, std::string >

Public Member Functions
	UdsMessage ()=default
	UdsMessage (const UdsMessage &other)=default
	UdsMessage (UdsMessage &&other) noexcept=default
UdsMessage &	operator= (const UdsMessage &other)=default
UdsMessage &	operator= (UdsMessage &&other) noexcept=default
virtual	~UdsMessage ()=default
virtual void	AddMetaInfo (std::shared_ptr< const MetaInfoMap > meta_info)=0
virtual const ByteVector &	GetPayload () const =0
virtual ByteVector &	GetPayload ()=0
virtual Address	GetSa () const noexcept=0
virtual Address	GetTa () const noexcept=0
virtual TargetAddressType	GetTaType () const noexcept=0
virtual IpAddress	GetHostIpAddress () const noexcept=0
virtual PortNumber	GetHostPortNumber () const noexcept=0

Detailed Description

Definition at line 19 of file uds_message.h.

Member Typedef Documentation

Address

using uds_transport::UdsMessage::Address = std::uint16_t

Definition at line 22 of file uds_message.h.

IpAddress

using uds_transport::UdsMessage::IpAddress = std::string_view

Definition at line 24 of file uds_message.h.

MetaInfoMap

using uds_transport::UdsMessage::MetaInfoMap = std::map<std::string, std::string>

Definition at line 28 of file uds_message.h.

PortNumber

using uds_transport::UdsMessage::PortNumber = std::uint16_t

Definition at line 26 of file uds_message.h.

Member Enumeration Documentation

TargetAddressType

enum uds_transport::UdsMessage::TargetAddressType : std::uint8_t

strong

Enumerator
kPhysical
kFunctional

Definition at line 30 of file uds_message.h.

: std::uint8_t { kPhysical = 0U, kFunctional = 1U };

Constructor & Destructor Documentation

UdsMessage() [1/3]

uds_transport::UdsMessage::UdsMessage ( )

default

UdsMessage() [2/3]

uds_transport::UdsMessage::UdsMessage ( const UdsMessage &  other )

default

UdsMessage() [3/3]

uds_transport::UdsMessage::UdsMessage ( UdsMessage &&  other )

defaultnoexcept

~UdsMessage()

virtual uds_transport::UdsMessage::~UdsMessage ( )

inlinevirtualdefault

Member Function Documentation

AddMetaInfo()

virtual void uds_transport::UdsMessage::AddMetaInfo ( std::shared_ptr< const MetaInfoMap >  meta_info )

pure virtual

Implemented in diag::client::uds_message::DmUdsMessage, and diag::client::vd_message::VdMessage.

GetHostIpAddress()

virtual IpAddress uds_transport::UdsMessage::GetHostIpAddress ( ) const

pure virtualnoexcept

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

GetHostPortNumber()

virtual PortNumber uds_transport::UdsMessage::GetHostPortNumber ( ) const

pure virtualnoexcept

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

GetPayload() [1/2]

virtual const ByteVector& uds_transport::UdsMessage::GetPayload ( ) const

pure virtual

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

GetPayload() [2/2]

virtual ByteVector& uds_transport::UdsMessage::GetPayload ( )

pure virtual

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

GetSa()

virtual Address uds_transport::UdsMessage::GetSa ( ) const

pure virtualnoexcept

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

GetTa()

virtual Address uds_transport::UdsMessage::GetTa ( ) const

pure virtualnoexcept

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

GetTaType()

virtual TargetAddressType uds_transport::UdsMessage::GetTaType ( ) const

pure virtualnoexcept

Implemented in diag::client::vd_message::VdMessage, and diag::client::uds_message::DmUdsMessage.

operator=() [1/2]

UdsMessage& uds_transport::UdsMessage::operator= ( const UdsMessage &  other )

default

operator=() [2/2]

UdsMessage& uds_transport::UdsMessage::operator= ( UdsMessage &&  other )

defaultnoexcept

---

The documentation for this class was generated from the following file:

• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/uds-transport-layer-api/uds_transport/uds_message.h