DoipLib::GenericNack Class Reference

Generic negative acknowledgement DoIP message. More...

#include <generic_nack.h>

Inheritance diagram for DoipLib::GenericNack:

Public Member Functions
	GenericNack (uint8_t protocolVersion, GenericNackType nackCode) noexcept
	Constructor. More...
GenericNackType	GetNackCode () const noexcept
	Get NACK code. 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

Generic negative acknowledgement DoIP message.

Constructor & Destructor Documentation

GenericNack()

DoipLib::GenericNack::GenericNack ( uint8_t  protocolVersion, GenericNackType  nackCode  )

noexcept

Constructor.

Parameters

protocolVersion	DoIP ISO protocol version
nackCode	Negative acknowledgement code

Member Function Documentation

GetNackCode()

GenericNackType DoipLib::GenericNack::GetNackCode ( ) const

noexcept

Get NACK code.

Returns

Negative acknoweledgement code

GetPayload()

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

overrideprotectedvirtual

Get message payload.

Parameters

[out]

payload

Payload byte array

Implements DoipLib::Message.

TrySetPayload()

virtual bool DoipLib::GenericNack::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.