DoipLib::RoutingActivationResponse Class Reference

Tester routing activation response to an internal vehicle network. More...

#include <routing_activation_response.h>

Inheritance diagram for DoipLib::RoutingActivationResponse:

Public Member Functions
	RoutingActivationResponse (uint8_t protocolVersion, uint16_t testerLogicalAddress, uint16_t entityLogicalAddress, RoutingActivationResponseType responseCode) noexcept
	Constructor without OEM-specific data. More...
	RoutingActivationResponse (uint8_t protocolVersion, uint16_t testerLogicalAddress, uint16_t entityLogicalAddress, RoutingActivationResponseType responseCode, uint32_t oemSpecificData) noexcept
	Constructor using OEM-specific data. More...
uint16_t	GetTesterLogicalAddress () const noexcept
	Get tester logical address. More...
uint16_t	GetEntityLogicalAddress () const noexcept
	Get entity logical address. More...
RoutingActivationResponseType	GetResponseCode () const noexcept
	Get response code. More...
bool	TryGetOemSpecificData (uint32_t &oemSpecificData) const noexcept
	Try to get the OEM-specific data. More...
Public Member Functions inherited from DoipLib::Message
void	Serialize (std::vector< uint8_t > &serializedMessage) const
	Serialize DoIP message. More...
bool	TryDeserialize (const std::vector< uint8_t > &serializedMessage, GenericNackType &nackCode)
	Try to deserialize DoIP message. More...

Protected Member Functions
void	GetPayload (std::vector< uint8_t > &payload) const override
	Get message payload. More...
virtual bool	TrySetPayload (const std::vector< uint8_t > &payload, uint32_t payloadLength) override
	Try to set message payload. More...
Protected Member Functions inherited from DoipLib::Message
	Message (PayloadType payloadType) noexcept
	Constructor. More...
	Message (uint8_t protocolVersion, PayloadType payloadType) noexcept
	Constructor. More...

Additional Inherited Members
Static Public Member Functions inherited from DoipLib::Message
static bool	TryExtractPayloadType (const std::vector< uint8_t > &serializedMessage, PayloadType &payloadType)
	Try to extract the payload type from the given serialized message. More...
Static Protected Attributes inherited from DoipLib::Message
static const std::size_t	cHeaderSize {8}
	DoIP message header size.

Detailed Description

Tester routing activation response to an internal vehicle network.

Constructor & Destructor Documentation

RoutingActivationResponse() [1/2]

DoipLib::RoutingActivationResponse::RoutingActivationResponse ( uint8_t  protocolVersion, uint16_t  testerLogicalAddress, uint16_t  entityLogicalAddress, RoutingActivationResponseType  responseCode  )

noexcept

Constructor without OEM-specific data.

Parameters

protocolVersion	DoIP ISO protocol version
testerLogicalAddress	External tester logical address
entityLogicalAddress	Internal DoIP entity logical address
responseCode	Routing activation response code

RoutingActivationResponse() [2/2]

DoipLib::RoutingActivationResponse::RoutingActivationResponse ( uint8_t  protocolVersion, uint16_t  testerLogicalAddress, uint16_t  entityLogicalAddress, RoutingActivationResponseType  responseCode, uint32_t  oemSpecificData  )

noexcept

Constructor using OEM-specific data.

Parameters

protocolVersion	DoIP ISO protocol version
testerLogicalAddress	External tester logical address
entityLogicalAddress	Internal DoIP entity logical address
responseCode	Routing activation response code
oemSpecificData	OEM-specific request data

Member Function Documentation

GetEntityLogicalAddress()

uint16_t DoipLib::RoutingActivationResponse::GetEntityLogicalAddress ( ) const

noexcept

Get entity logical address.

Returns

Internal DoIP entity logical address

GetPayload()

void DoipLib::RoutingActivationResponse::GetPayload ( std::vector< uint8_t > &  payload ) const

overrideprotectedvirtual

Get message payload.

Parameters

[out]

payload

Payload byte array

Implements DoipLib::Message.

GetResponseCode()

RoutingActivationResponseType DoipLib::RoutingActivationResponse::GetResponseCode ( ) const

noexcept

Get response code.

Returns

Routing activation response code

GetTesterLogicalAddress()

uint16_t DoipLib::RoutingActivationResponse::GetTesterLogicalAddress ( ) const

noexcept

Get tester logical address.

Returns

External tester logical address

TryGetOemSpecificData()

bool DoipLib::RoutingActivationResponse::TryGetOemSpecificData ( uint32_t &  oemSpecificData ) const

noexcept

Try to get the OEM-specific data.

Parameters

[out]

oemSpecificData

OEM-specific request data

Returns

True if the data is available, otherwise false

TrySetPayload()

virtual bool DoipLib::RoutingActivationResponse::TrySetPayload ( const std::vector< uint8_t > &  payload, uint32_t  payloadLength  )

overrideprotectedvirtual

Try to set message payload.

Parameters

[in]	payload	Payload byte array
[in]	payloadLength	Payload length from the message header

Returns

True if the payload is set successfully, otherwise false

Implements DoipLib::Message.