Factory functions for creating specific DoIP message types. More...

Functions
DoIPMessage	makeVehicleIdentificationRequest ()
	Creates a vehicle identification request message. More...

DoIPMessage	makeVehicleIdentificationResponse (const DoIpVin &vin, const DoIPAddress &logicalAddress, const DoIpEid &entityType, const DoIpGid &groupId, DoIPFurtherAction furtherAction=DoIPFurtherAction::NoFurtherAction, DoIPSyncStatus syncStatus=DoIPSyncStatus::GidVinSynchronized)
	Creates a vehicle identification response message. More...

DoIPMessage	makeNegativeAckMessage (DoIPNegativeAck nack)
	Creates a generic DoIP negative response (NACK). More...

DoIPMessage	makeDiagnosticMessage (const DoIPAddress &sa, const DoIPAddress &ta, const ByteArray &msg_payload)
	Creates a diagnostic message. More...

DoIPMessage	makeDiagnosticPositiveResponse (const DoIPAddress &sa, const DoIPAddress &ta, const ByteArray &msg_payload)
	void b More...

DoIPMessage	makeDiagnosticNegativeResponse (const DoIPAddress &sa, const DoIPAddress &ta, DoIPNegativeDiagnosticAck nack, const ByteArray &msg_payload)
	Creates a diagnostic negative ACK message (NACK). More...

DoIPMessage	makeAliveCheckRequest ()
	Create an 'alive check' request. More...

DoIPMessage	makeAliveCheckResponse (const DoIPAddress &sa)
	Create an 'alive check' response. More...

DoIPMessage	makeRoutingActivationRequest (const DoIPAddress &ea, DoIPRoutingActivationType actType=DoIPRoutingActivationType::Default)
	Creates a routing activation request message. More...

DoIPMessage	makeRoutingActivationResponse (const DoIPMessage &routingReq, const DoIPAddress &ea, DoIPRoutingActivationType actType=DoIPRoutingActivationType::Default)
	Creates a routing activation response message. More...

Detailed Description

Factory functions for creating specific DoIP message types.

These functions provide a clean, type-safe interface for creating different types of DoIP messages without polluting the base class.

Function Documentation

◆ makeAliveCheckRequest()

DoIPMessage doip::message::makeAliveCheckRequest ( )

inline

Create an 'alive check' request.

Returns: DoIPMessage

Definition at line 637 of file DoIPMessage.h.

References doip::AliveCheckRequest.

Referenced by doip::DoIPDefaultConnection::sendAliveCheckRequest().

◆ makeAliveCheckResponse()

DoIPMessage doip::message::makeAliveCheckResponse ( const DoIPAddress & sa )

inline

Create an 'alive check' response.

Parameters

sa	the source address

Returns: DoIPMessage

Definition at line 647 of file DoIPMessage.h.

References doip::AliveCheckResponse, and doip::ByteArray::writeU16BE().

Referenced by doip::DoIPClient::sendAliveCheckResponse().

◆ makeDiagnosticMessage()

DoIPMessage doip::message::makeDiagnosticMessage	(	const DoIPAddress &	sa,
		const DoIPAddress &	ta,
		const ByteArray &	msg_payload
	)

inline

Creates a diagnostic message.

Parameters

sa	the source address
ta	the target address
msg_payload	the original diagnostic messages (e.g. UDS message)

Returns: DoIPMessage the DoIP message

Definition at line 567 of file DoIPMessage.h.

References doip::DiagnosticMessage, and doip::ByteArray::writeU16BE().

Referenced by doip::DoIPDefaultConnection::receiveDownstreamResponse(), doip::DoIPClient::sendDiagnosticMessage(), and doip::DoIPDefaultConnection::sendDownstreamResponse().

◆ makeDiagnosticNegativeResponse()

DoIPMessage doip::message::makeDiagnosticNegativeResponse	(	const DoIPAddress &	sa,
		const DoIPAddress &	ta,
		DoIPNegativeDiagnosticAck	nack,
		const ByteArray &	msg_payload
	)

inline

Creates a diagnostic negative ACK message (NACK).

Parameters

sa	the source address
ta	the target address
nack	the negative acknowledgment code
msg_payload	the original diagnostic messages (e.g. UDS message)

Returns: DoIPMessage the DoIP message

Definition at line 615 of file DoIPMessage.h.

References doip::DiagnosticMessageNegativeAck, and doip::ByteArray::writeU16BE().

Referenced by doip::DoIPDefaultConnection::receiveDownstreamResponse(), and doip::DoIPDefaultConnection::sendDiagnosticMessageResponse().

◆ makeDiagnosticPositiveResponse()

DoIPMessage doip::message::makeDiagnosticPositiveResponse	(	const DoIPAddress &	sa,
		const DoIPAddress &	ta,
		const ByteArray &	msg_payload
	)

inline

void b

Creates a diagnostic positive ACK message.

Parameters

sa	the source address
ta	the target address
msg_payload	the original diagnostic messages (e.g. UDS message)

Returns: DoIPMessage the DoIP message

Definition at line 590 of file DoIPMessage.h.

References doip::DIAGNOSTIC_MESSAGE_ACK, doip::DiagnosticMessageAck, and doip::ByteArray::writeU16BE().

Referenced by doip::DoIPDefaultConnection::sendDiagnosticMessageResponse().

◆ makeNegativeAckMessage()

DoIPMessage doip::message::makeNegativeAckMessage ( DoIPNegativeAck nack )

inline

Creates a generic DoIP negative response (NACK).

Parameters

nack	the negative response code

Returns: DoIPMessage the DoIP message

Definition at line 555 of file DoIPMessage.h.

References doip::NegativeAck.

◆ makeRoutingActivationRequest()

DoIPMessage doip::message::makeRoutingActivationRequest	(	const DoIPAddress &	ea,
		DoIPRoutingActivationType	actType = `DoIPRoutingActivationType::Default`
	)

inline

Creates a routing activation request message.

Parameters

ea	the entity address
actType	the activation type

Returns: DoIPMessage the activation request message

Definition at line 660 of file DoIPMessage.h.

References doip::RoutingActivationRequest, doip::ByteArray::writeEnum(), and doip::ByteArray::writeU16BE().

Referenced by doip::DoIPClient::sendRoutingActivationRequest().

◆ makeRoutingActivationResponse()

DoIPMessage doip::message::makeRoutingActivationResponse	(	const DoIPMessage &	routingReq,
		const DoIPAddress &	ea,
		DoIPRoutingActivationType	actType = `DoIPRoutingActivationType::Default`
	)

inline

Creates a routing activation response message.

Parameters

routingReq	the routing request message
ea	the entity address
actType	the activation type

Returns: DoIPMessage the activation response message

Definition at line 682 of file DoIPMessage.h.

References doip::DoIPMessage::getSourceAddress(), doip::RoutingActivationResponse, and doip::ByteArray::writeU16BE().

◆ makeVehicleIdentificationRequest()

DoIPMessage doip::message::makeVehicleIdentificationRequest ( )

inline

Creates a vehicle identification request message.

Returns: DoIPMessage the vehicle identification request

Definition at line 513 of file DoIPMessage.h.

References doip::VehicleIdentificationRequest.

Referenced by doip::DoIPClient::sendVehicleIdentificationRequest().

◆ makeVehicleIdentificationResponse()

DoIPMessage doip::message::makeVehicleIdentificationResponse	(	const DoIpVin &	vin,
		const DoIPAddress &	logicalAddress,
		const DoIpEid &	entityType,
		const DoIpGid &	groupId,
		DoIPFurtherAction	furtherAction = `DoIPFurtherAction::NoFurtherAction`,
		DoIPSyncStatus	syncStatus = `DoIPSyncStatus::GidVinSynchronized`
	)

inline

Creates a vehicle identification response message.

Parameters

vin	the vehicle identification number (VIN)
logicalAddress	the logical address of the entity
entityType	the entity identifier (EID)
groupId	the group identifier (GID)
furtherAction	the further action code
syncStatus	the synchronization status

Returns: DoIPMessage the vehicle identification response message

Definition at line 528 of file DoIPMessage.h.

References doip::GenericFixedId< IdLength, zeroPadding, padChar >::begin(), doip::GenericFixedId< IdLength, zeroPadding, padChar >::end(), doip::GenericFixedId< IdLength, zeroPadding, padChar >::size(), doip::VehicleIdentificationResponse, doip::ByteArray::writeEnum(), and doip::ByteArray::writeU16BE().

Functions

Detailed Description

Function Documentation

◆ makeAliveCheckRequest()

◆ makeAliveCheckResponse()

◆ makeDiagnosticMessage()

◆ makeDiagnosticNegativeResponse()

◆ makeDiagnosticPositiveResponse()

◆ makeNegativeAckMessage()

◆ makeRoutingActivationRequest()

◆ makeRoutingActivationResponse()

◆ makeVehicleIdentificationRequest()

◆ makeVehicleIdentificationResponse()