Represents a DoIP Routing Activation Request message. More...

#include <DoIpLayer.h>

Inheritance diagram for pcpp::DoIpRoutingActivationRequest:

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

	DoIpRoutingActivationRequest (uint16_t sourceAddress, DoIpActivationTypes activationType)
	Constructs the message from field values. More...

uint16_t	getSourceAddress () const
	Returns the source address. More...

void	setSourceAddress (uint16_t value)
	Sets the source address. More...

DoIpActivationTypes	getActivationType () const
	Returns the activation type. More...

void	setActivationType (DoIpActivationTypes activationType)
	Sets the activation type. More...

std::array< uint8_t, DOIP_RESERVED_ISO_LEN >	getReservedIso () const
	Gets the reserved ISO bytes. More...

void	setReservedIso (const std::array< uint8_t, DOIP_RESERVED_ISO_LEN > &reservedIso)
	Sets the reserved ISO bytes. More...

std::array< uint8_t, DOIP_RESERVED_OEM_LEN >	getReservedOem () const
	Gets the to reserved OEM bytes if present. More...

void	setReservedOem (const std::array< uint8_t, DOIP_RESERVED_OEM_LEN > &reservedOem)
	Sets the reserved OEM bytes. More...

bool	hasReservedOem () const
	Checks if OEM reserved bytes are present. More...

void	clearReservedOem ()
	Clears the OEM reserved bytes.

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

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

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
	Copy the raw data of this layer to another array. More...

size_t	copyData (uint8_t *dest, size_t destSize) const
	Copy the raw data of this layer to another array, with a specified maximum size. More...

uint8_t *	getDataPtr (size_t offset=0) const override

Static Public Member Functions
static bool	isDataLenValid (size_t dataLen)
	Checks if the routing activation request 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...

void	allocData (size_t dataLen, bool zeroInit=true)
	Requests the layer to allocate a new data buffer of the specified length. 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 Routing Activation Request message.

Provides parsing and construction for Routing Activation Request messages as defined by the DoIP protocol.

Constructor & Destructor Documentation

◆ DoIpRoutingActivationRequest() [1/2]

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

Constructs the layer from raw DoIP packet data.

Parameters

[in]	data	Pointer to raw packet data.
[in]	dataLen	Length of the raw data.
[in]	prevLayer	Pointer to the previous layer.
[in]	packet	Pointer to the parent packet instance.

◆ DoIpRoutingActivationRequest() [2/2]

pcpp::DoIpRoutingActivationRequest::DoIpRoutingActivationRequest	(	uint16_t	sourceAddress,
		DoIpActivationTypes	activationType
	)

Constructs the message from field values.

Parameters

[in]	sourceAddress	Source address of the tester.
[in]	activationType	Type of routing activation.

Member Function Documentation

◆ getActivationType()

DoIpActivationTypes pcpp::DoIpRoutingActivationRequest::getActivationType ( ) const

Returns the activation type.

Returns: The activation type as a DoIpActivationTypes enum value.

◆ getReservedIso()

std::array<uint8_t, DOIP_RESERVED_ISO_LEN> pcpp::DoIpRoutingActivationRequest::getReservedIso ( ) const

Gets the reserved ISO bytes.

Returns: 4-byte array representing the reserved ISO bytes.

◆ getReservedOem()

std::array<uint8_t, DOIP_RESERVED_OEM_LEN> pcpp::DoIpRoutingActivationRequest::getReservedOem ( ) const

Gets the to reserved OEM bytes if present.

Exceptions

std::runtime_error if the reserved OEM bytes are not present.

Note: To use this method safely, check beforehand if the reserved OEM bytes are present using hasReservedOem().

◆ getSourceAddress()

uint16_t pcpp::DoIpRoutingActivationRequest::getSourceAddress ( ) const

Returns the source address.

Returns: The 2-byte source address.

◆ hasReservedOem()

bool pcpp::DoIpRoutingActivationRequest::hasReservedOem ( ) const

Checks if OEM reserved bytes are present.

Returns: true if OEM reserved bytes are present, false otherwise.

◆ isDataLenValid()

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

inlinestatic

Checks if the routing activation request data length is valid.

Parameters

[in] dataLen The length of the data.

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

◆ setActivationType()

void pcpp::DoIpRoutingActivationRequest::setActivationType ( DoIpActivationTypes activationType )

Sets the activation type.

Parameters

[in] activationType The activation type to set.

◆ setReservedIso()

void pcpp::DoIpRoutingActivationRequest::setReservedIso ( const std::array< uint8_t, DOIP_RESERVED_ISO_LEN > & reservedIso )

Sets the reserved ISO bytes.

Parameters

[in] reservedIso The reserved ISO bytes to set.

◆ setReservedOem()

void pcpp::DoIpRoutingActivationRequest::setReservedOem ( const std::array< uint8_t, DOIP_RESERVED_OEM_LEN > & reservedOem )

Sets the reserved OEM bytes.

Parameters

[in] reservedOem The reserved OEM bytes to set.

◆ setSourceAddress()

void pcpp::DoIpRoutingActivationRequest::setSourceAddress ( uint16_t value )

Sets the source address.

Parameters

[in] value The source address to set.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DoIpRoutingActivationRequest() [1/2]

◆ DoIpRoutingActivationRequest() [2/2]

Member Function Documentation

◆ getActivationType()

◆ getReservedIso()

◆ getReservedOem()

◆ getSourceAddress()

◆ hasReservedOem()

◆ isDataLenValid()

◆ setActivationType()

◆ setReservedIso()

◆ setReservedOem()

◆ setSourceAddress()