Woman, Life, Freedom


DoIP Library
Diagnostics over Internet Protocol (DoIP) C++ library
DoipLib::EntityStatusRequest Class Reference

Diagnostic entity status request. More...

#include <entity_status_request.h>

Inheritance diagram for DoipLib::EntityStatusRequest:
DoipLib::Message

Public Member Functions

 EntityStatusRequest (uint8_t protocolVersion) noexcept
 Constructor. 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

Diagnostic entity status request.

Constructor & Destructor Documentation

◆ EntityStatusRequest()

DoipLib::EntityStatusRequest::EntityStatusRequest ( uint8_t  protocolVersion)
explicitnoexcept

Constructor.

Parameters
protocolVersionDoIP ISO protocol version

Member Function Documentation

◆ GetPayload()

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

Get message payload.

Parameters
[out]payloadPayload byte array

Implements DoipLib::Message.

◆ TrySetPayload()

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

Try to set message payload.

Parameters
[in]payloadPayload byte array
[in]payloadLengthPayload length from the message header
Returns
True if the payload is set successfully, otherwise false

Implements DoipLib::Message.