Represents a DoIP Vehicle Announcement message. More...

#include <DoIpLayer.h>

Inheritance diagram for pcpp::DoIpVehicleAnnouncementMessage:

Public Member Functions
	DoIpVehicleAnnouncementMessage (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)
	Constructs the layer from raw DoIP packet data. More...

	DoIpVehicleAnnouncementMessage (const std::array< uint8_t, DOIP_VIN_LEN > &vin, uint16_t logicalAddress, const std::array< uint8_t, DOIP_EID_LEN > &eid, const std::array< uint8_t, DOIP_GID_LEN > &gid, DoIpActionCodes actionCode)
	Constructs the message using specified field values. More...

std::array< uint8_t, DOIP_VIN_LEN >	getVIN () const
	Gets the Vehicle Identification Number (VIN). More...

void	setVIN (const std::array< uint8_t, DOIP_VIN_LEN > &vin)
	Sets the Vehicle Identification Number (VIN). More...

uint16_t	getLogicalAddress () const
	Gets the logical address of the vehicle. More...

void	setLogicalAddress (uint16_t address)
	Sets the logical address. More...

std::array< uint8_t, DOIP_EID_LEN >	getEID () const
	Gets the Entity Identifier (EID). More...

void	setEID (const std::array< uint8_t, DOIP_EID_LEN > &eid)
	Sets the Entity Identifier (EID). More...

std::array< uint8_t, DOIP_GID_LEN >	getGID () const
	Gets the Group Identifier (GID). More...

void	setGID (const std::array< uint8_t, DOIP_GID_LEN > &gid)
	Sets the Group Identifier (GID). More...

DoIpActionCodes	getFurtherActionRequired () const
	Gets the further action required code. More...

void	setFurtherActionRequired (DoIpActionCodes action)
	Sets the further action required code. More...

DoIpSyncStatus	getSyncStatus () const
	Gets the optional synchronization status if available. More...

void	setSyncStatus (DoIpSyncStatus sync)
	Sets the synchronization status. More...

bool	hasSyncStatus () const
	Checks whether the sync status is present. More...

void	clearSyncStatus ()
	Clears the optional sync status field.

std::string	getSummary () const
	Returns a human-readable summary of the message.

DoIpPayloadTypes	getPayloadType () const override
	Returns the DoIP payload type.

Public Member Functions inherited from pcpp::DoIpLayer
std::string	getPayloadTypeAsStr () const

DoIpProtocolVersion	getProtocolVersion () const

std::string	getProtocolVersionAsStr () const

void	setProtocolVersion (DoIpProtocolVersion version)

void	setProtocolVersion (uint8_t rawVersion)

uint8_t	getInvertProtocolVersion () const

void	setInvertProtocolVersion (uint8_t iVersion)

uint32_t	getPayloadLength () const

void	setPayloadLength (uint32_t length)

void	parseNextLayer () override
	parse UDS layer

size_t	getHeaderLen () const override

std::string	toString () const override

void	computeCalculateFields () override
	Each layer can compute field values automatically using this method. This is an abstract method.

OsiModelLayer	getOsiModelLayer () const override

Public Member Functions inherited from pcpp::Layer
	~Layer () override

Layer *	getNextLayer () const

Layer *	getPrevLayer () const

ProtocolType	getProtocol () const

bool	isMemberOfProtocolFamily (ProtocolTypeFamily protocolTypeFamily) const

uint8_t *	getData () const

size_t	getDataLen () const

uint8_t *	getLayerPayload () const

size_t	getLayerPayloadSize () const

bool	isAllocatedToPacket () const

void	copyData (uint8_t *toArr) const

uint8_t *	getDataPtr (size_t offset=0) const override

Static Public Member Functions
static bool	isDataLenValid (size_t dataLen)
	checks if the vehicle announcement data length is valid. More...

Static Public Member Functions inherited from pcpp::DoIpLayer
static DoIpLayer *	parseDoIpLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

static bool	isDoIpPort (uint16_t port)

static bool	isDataValid (uint8_t *data, size_t dataLen)

Additional Inherited Members
Protected Member Functions inherited from pcpp::Layer
Packet *	getAttachedPacket ()
	Get a pointer to the Packet this layer is attached to (if any). More...

Packet const *	getAttachedPacket () const
	Get a pointer to the Packet this layer is attached to (if any). More...

template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack. No validation is performed on the data. More...

template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...

template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...

template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)

template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack with a fallback option. More...

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...

template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...

Static Protected Member Functions inherited from pcpp::Layer
template<typename T >
static bool	canReinterpretAs (const uint8_t *data, size_t dataLen)
	Check if the data is large enough to reinterpret as a type. More...

Detailed Description

Represents a DoIP Vehicle Announcement message.

This message is broadcasted by a vehicle to announce its presence, including VIN, logical address, EID, GID, and optionally synchronization status.

Constructor & Destructor Documentation

◆ DoIpVehicleAnnouncementMessage() [1/2]

pcpp::DoIpVehicleAnnouncementMessage::DoIpVehicleAnnouncementMessage	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

Constructs the layer from raw DoIP packet data.

Parameters

[in]	data	Pointer to the raw data buffer.
[in]	dataLen	Size of the data buffer in bytes.
[in]	prevLayer	Pointer to the previous protocol layer.
[in]	packet	Pointer to the parent packet.

◆ DoIpVehicleAnnouncementMessage() [2/2]

pcpp::DoIpVehicleAnnouncementMessage::DoIpVehicleAnnouncementMessage	(	const std::array< uint8_t, DOIP_VIN_LEN > &	vin,
		uint16_t	logicalAddress,
		const std::array< uint8_t, DOIP_EID_LEN > &	eid,
		const std::array< uint8_t, DOIP_GID_LEN > &	gid,
		DoIpActionCodes	actionCode
	)

Constructs the message using specified field values.

Parameters

[in]	vin	Vehicle Identification Number (VIN).
[in]	logicalAddress	Logical address of the vehicle.
[in]	eid	Entity Identifier (EID).
[in]	gid	Group Identifier (GID).
[in]	actionCode	Further action code.

Member Function Documentation

◆ getEID()

std::array<uint8_t, DOIP_EID_LEN> pcpp::DoIpVehicleAnnouncementMessage::getEID ( ) const

Gets the Entity Identifier (EID).

Returns: A 6-byte Entity Identifier (EID).

◆ getFurtherActionRequired()

DoIpActionCodes pcpp::DoIpVehicleAnnouncementMessage::getFurtherActionRequired ( ) const

Gets the further action required code.

Returns: enum DoIpActionCodes representing the further action required code.

◆ getGID()

std::array<uint8_t, DOIP_GID_LEN> pcpp::DoIpVehicleAnnouncementMessage::getGID ( ) const

Gets the Group Identifier (GID).

Returns: A 6-byte Group Identifier (GID).

◆ getLogicalAddress()

uint16_t pcpp::DoIpVehicleAnnouncementMessage::getLogicalAddress ( ) const

Gets the logical address of the vehicle.

Returns: A 2-byte logical address of the vehicle.

◆ getSyncStatus()

DoIpSyncStatus pcpp::DoIpVehicleAnnouncementMessage::getSyncStatus ( ) const

Gets the optional synchronization status if available.

Exceptions

std::runtime_error if the sync status is not present.

Note: To use this method safely, check beforehand if the sync status is present using hasSyncStatus().

Returns: A 1-byte synchronization status.

◆ getVIN()

std::array<uint8_t, DOIP_VIN_LEN> pcpp::DoIpVehicleAnnouncementMessage::getVIN ( ) const

Gets the Vehicle Identification Number (VIN).

Returns: A 17-byte Vehicle Identification Number (VIN).

◆ hasSyncStatus()

bool pcpp::DoIpVehicleAnnouncementMessage::hasSyncStatus ( ) const

Checks whether the sync status is present.

Returns: true if the sync status is present, false otherwise.

◆ isDataLenValid()

static bool pcpp::DoIpVehicleAnnouncementMessage::isDataLenValid ( size_t dataLen )

inlinestatic

checks if the vehicle announcement data length is valid.

Parameters

[in] dataLen Length of the data buffer.

Returns: true if the data length is valid, false otherwise.

◆ setEID()

void pcpp::DoIpVehicleAnnouncementMessage::setEID ( const std::array< uint8_t, DOIP_EID_LEN > & eid )

Sets the Entity Identifier (EID).

Parameters

[in] eid A 6-byte Entity Identifier (EID).

◆ setFurtherActionRequired()

void pcpp::DoIpVehicleAnnouncementMessage::setFurtherActionRequired ( DoIpActionCodes action )

Sets the further action required code.

Parameters

[in] action enum DoIpActionCodes representing the further action required code to set.

◆ setGID()

void pcpp::DoIpVehicleAnnouncementMessage::setGID ( const std::array< uint8_t, DOIP_GID_LEN > & gid )

Sets the Group Identifier (GID).

Parameters

[in] gid A 6-byte Group Identifier (GID).

◆ setLogicalAddress()

void pcpp::DoIpVehicleAnnouncementMessage::setLogicalAddress ( uint16_t address )

Sets the logical address.

Parameters

[in] address A 2-byte logical address of the vehicle.

◆ setSyncStatus()

void pcpp::DoIpVehicleAnnouncementMessage::setSyncStatus ( DoIpSyncStatus sync )

Sets the synchronization status.

Parameters

[in] sync enum DoIpSyncStatus representing the synchronization status to set.

◆ setVIN()

void pcpp::DoIpVehicleAnnouncementMessage::setVIN ( const std::array< uint8_t, DOIP_VIN_LEN > & vin )

Sets the Vehicle Identification Number (VIN).

Parameters

[in] vin A 17-byte Vehicle Identification Number (VIN).

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DoIpVehicleAnnouncementMessage() [1/2]

◆ DoIpVehicleAnnouncementMessage() [2/2]

Member Function Documentation

◆ getEID()

◆ getFurtherActionRequired()

◆ getGID()

◆ getLogicalAddress()

◆ getSyncStatus()

◆ getVIN()

◆ hasSyncStatus()

◆ isDataLenValid()

◆ setEID()

◆ setFurtherActionRequired()

◆ setGID()

◆ setLogicalAddress()

◆ setSyncStatus()

◆ setVIN()