PcapPlusPlus  Next
pcpp::DoIpDiagnosticResponseMessageBase Class Reference

Represents a Basic class for Diagnostic message (ACK/NACK) sent back to tester. More...

#include <DoIpLayer.h>

Inheritance diagram for pcpp::DoIpDiagnosticResponseMessageBase:
pcpp::DoIpDiagnosticBase pcpp::DoIpLayer pcpp::Layer pcpp::IDataContainer pcpp::DoIpDiagnosticMessageAck pcpp::DoIpDiagnosticMessageNack

Public Member Functions

uint8_t getResponseCode () const
 Gets the acknowledgment/nack code (1-byte). More...
 
void setResponseCode (uint8_t code)
 Sets the acknowledgment/nack code (1-byte). More...
 
std::vector< uint8_t > getPreviousMessage () const
 Gets the optional previously echoed diagnostic message. More...
 
bool hasPreviousMessage () const
 Checks if a previous message is attached. More...
 
void setPreviousMessage (const std::vector< uint8_t > &msg)
 Sets the previous echoed diagnostic message. More...
 
void clearPreviousMessage ()
 Clears the previously stored diagnostic message.
 
- Public Member Functions inherited from pcpp::DoIpDiagnosticBase
uint16_t getSourceAddress () const
 Gets the source logical address of the message. More...
 
void setSourceAddress (uint16_t sourceAddress)
 Sets the source logical address. More...
 
uint16_t getTargetAddress () const
 Gets the target logical address of the message. More...
 
void setTargetAddress (uint16_t targetAddress)
 Sets the target logical address. More...
 
virtual std::string getSummary () const =0
 Returns a human-readable summary of the message content. More...
 
- Public Member Functions inherited from pcpp::DoIpLayer
virtual DoIpPayloadTypes getPayloadType () const =0
 
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
 
LayergetNextLayer () const
 
LayergetPrevLayer () 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 data length is valid. More...
 
- Static Public Member Functions inherited from pcpp::DoIpLayer
static DoIpLayerparseDoIpLayer (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
template<typename T , typename... Args>
LayerconstructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 
template<typename T , typename TFallback , typename... Args>
LayertryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 
- 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 Basic class for Diagnostic message (ACK/NACK) sent back to tester.

Member Function Documentation

◆ getPreviousMessage()

std::vector<uint8_t> pcpp::DoIpDiagnosticResponseMessageBase::getPreviousMessage ( ) const

Gets the optional previously echoed diagnostic message.

Returns
A vector containing the previously echoed diagnostic message.

◆ getResponseCode()

uint8_t pcpp::DoIpDiagnosticResponseMessageBase::getResponseCode ( ) const

Gets the acknowledgment/nack code (1-byte).

Returns
The acknowledgment/nack code.

◆ hasPreviousMessage()

bool pcpp::DoIpDiagnosticResponseMessageBase::hasPreviousMessage ( ) const

Checks if a previous message is attached.

Returns
true if a previous message is present, false otherwise.

◆ isDataLenValid()

static bool pcpp::DoIpDiagnosticResponseMessageBase::isDataLenValid ( size_t  dataLen)
inlinestatic

Checks if data length is valid.

Parameters
[in]dataLenLength of the data buffer.
Returns
true if the data length is valid, false otherwise.

◆ setPreviousMessage()

void pcpp::DoIpDiagnosticResponseMessageBase::setPreviousMessage ( const std::vector< uint8_t > &  msg)

Sets the previous echoed diagnostic message.

Parameters
[in]msgA vector containing the previously echoed diagnostic message.

◆ setResponseCode()

void pcpp::DoIpDiagnosticResponseMessageBase::setResponseCode ( uint8_t  code)

Sets the acknowledgment/nack code (1-byte).

Parameters
[in]codeThe acknowledgment/nack code to set.