#include <SomeIpSdLayer.h>

Inheritance diagram for pcpp::SomeIpSdLayer:

Public Member Functions
	SomeIpSdLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

	SomeIpSdLayer (uint16_t serviceID, uint16_t methodID, uint16_t clientID, uint16_t sessionID, uint8_t interfaceVersion, MsgType type, uint8_t returnCode, uint8_t flags)

	~SomeIpSdLayer () override=default
	Destroy the layer object.

uint8_t	getFlags () const

void	setFlags (uint8_t flags)

uint32_t	getNumEntries () const

uint32_t	getNumOptions () const

const EntriesVec	getEntries () const

const OptionsVec	getOptions () const

const OptionsVec	getOptionsFromEntry (uint32_t index) const

uint32_t	addEntry (const SomeIpSdEntry &entry)

bool	addOptionTo (uint32_t indexEntry, const SomeIpSdOption &option)

void	computeCalculateFields () override
	Does nothing for this layer.

std::string	toString () const override

Public Member Functions inherited from pcpp::SomeIpLayer
	SomeIpLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

	SomeIpLayer (uint16_t serviceID, uint16_t methodID, uint16_t clientID, uint16_t sessionID, uint8_t interfaceVersion, MsgType type, uint8_t returnCode, const uint8_t *const data=nullptr, size_t dataLen=0)

	~SomeIpLayer () override=default
	Destroy the layer object.

someiphdr *	getSomeIpHeader () const

uint32_t	getMessageID () const

void	setMessageID (uint32_t messageID)

uint16_t	getServiceID () const

void	setServiceID (uint16_t serviceID)

uint16_t	getMethodID () const

void	setMethodID (uint16_t methodID)

uint32_t	getLengthField () const

uint32_t	getRequestID () const

void	setRequestID (uint32_t requestID)

uint16_t	getSessionID () const

void	setSessionID (uint16_t sessionID)

uint16_t	getClientID () const

void	setClientID (uint16_t clientID)

uint8_t	getProtocolVersion () const

void	setProtocolVersion (uint8_t version)

uint8_t	getInterfaceVersion () const

void	setInterfaceVersion (uint8_t version)

uint8_t	getMessageTypeAsInt () const

SomeIpLayer::MsgType	getMessageType () const

void	setMessageType (MsgType type)

void	setMessageType (uint8_t type)

uint8_t	getReturnCode () const

void	setReturnCode (uint8_t returnCode)

void	setPayloadLength (uint32_t payloadLength)

uint8_t *	getPduPayload () const

size_t	getPduPayloadSize () const

size_t	getHeaderLen () const override

void	parseNextLayer () override
	Identifies the following next layers: SomeIpLayer, SomeIpTpLayer, SomeIpSdLayer. Otherwise sets PayloadLayer.

OsiModelLayer	getOsiModelLayer () const override

Public Member Functions inherited from pcpp::Layer
	~Layer () override

Layer *	getNextLayer () const

Layer *	getPrevLayer () 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	isSomeIpSdPort (uint16_t port)

static bool	isDataValid (const uint8_t *data, size_t dataLen)

Static Public Member Functions inherited from pcpp::SomeIpLayer
static Layer *	parseSomeIpLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

static bool	isSomeIpPort (uint16_t port)

static void	addSomeIpPort (uint16_t port)

static void	removeSomeIpPort (uint16_t port)

static void	removeAllSomeIpPorts ()
	Removes all ports from a list of ports where pcap checks for SOME/IP communication.

Additional Inherited Members
Public Types inherited from pcpp::SomeIpLayer
enum class	MsgType : uint8_t { REQUEST = 0x00 , REQUEST_ACK = 0x40 , REQUEST_NO_RETURN = 0x01 , REQUEST_NO_RETURN_ACK = 0x41 , NOTIFICATION = 0x02 , NOTIFICATION_ACK = 0x42 , RESPONSE = 0x80 , RESPONSE_ACK = 0xC0 , ERRORS = 0x81 , ERROR_ACK = 0xC1 , TP_REQUEST = 0x20 , TP_REQUEST_NO_RETURN = 0x21 , TP_NOTIFICATION = 0x22 , TP_RESPONSE = 0xa0 , TP_ERROR = 0xa1 }
	SOME/IP message types. More...

Protected Member Functions inherited from pcpp::Layer
template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (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

Implementation of the SOME/IP-SD protocol

Constructor & Destructor Documentation

◆ SomeIpSdLayer() [1/2]

pcpp::SomeIpSdLayer::SomeIpSdLayer	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

A constructor that creates the layer from an existing packet raw data

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	A pointer to the previous layer
[in]	packet	A pointer to the Packet instance where layer will be stored in

◆ SomeIpSdLayer() [2/2]

pcpp::SomeIpSdLayer::SomeIpSdLayer	(	uint16_t	serviceID,
		uint16_t	methodID,
		uint16_t	clientID,
		uint16_t	sessionID,
		uint8_t	interfaceVersion,
		MsgType	type,
		uint8_t	returnCode,
		uint8_t	flags
	)

Construct a new SomeIpSdLayer object

Parameters

[in]	serviceID	Service ID
[in]	methodID	Method ID
[in]	clientID	Client ID
[in]	sessionID	Session ID
[in]	interfaceVersion	Interface Version
[in]	type	Type of the message
[in]	returnCode	Return Code
[in]	flags	Flags that shall be used in the header

Member Function Documentation

◆ addEntry()

uint32_t pcpp::SomeIpSdLayer::addEntry ( const SomeIpSdEntry & entry )

Adds a given entry to the layer and returns the index of the entry

Parameters

[in] entry Pointer to the entry that shall be added to the layer

Returns: uint32_t Returns the index of the entry starting with 0

◆ addOptionTo()

bool pcpp::SomeIpSdLayer::addOptionTo	(	uint32_t	indexEntry,
		const SomeIpSdOption &	option
	)

Adds an option to an entry that has already been added to the layer by using addEntry(). The option is also added to the layer itself. If the option cannot by assigned to the entry, the option is not copied into the layer.

Parameters

[in]	indexEntry	Index of the entry where the option shall be added. First Entry has index 0
[in]	option	Pointer to the option that shall be added

Returns: True if the option could be assigned to the entry and was copied into the layer, false otherwise

◆ getEntries()

const EntriesVec pcpp::SomeIpSdLayer::getEntries ( ) const

Get the Entries from this layer

Returns: EntriesVec Vector holding pointers to the options

◆ getFlags()

uint8_t pcpp::SomeIpSdLayer::getFlags ( ) const

Get the Flags of the layer

Returns: uint8_t Flags

◆ getNumEntries()

uint32_t pcpp::SomeIpSdLayer::getNumEntries ( ) const

Get the number of entries in this layer

Returns: uint32_t

◆ getNumOptions()

uint32_t pcpp::SomeIpSdLayer::getNumOptions ( ) const

Get the number of options in this layer

Returns: uint32_t

◆ getOptions()

const OptionsVec pcpp::SomeIpSdLayer::getOptions ( ) const

Get the Options from this layer

Returns: OptionsVec Vector holding pointers to the options

◆ getOptionsFromEntry()

const OptionsVec pcpp::SomeIpSdLayer::getOptionsFromEntry ( uint32_t index ) const

Get the Options from a specific Entry

Parameters

[in] index Index of the Entry, starting with 0.

Returns: OptionsVec Vector holding pointers to the options

◆ isDataValid()

static bool pcpp::SomeIpSdLayer::isDataValid	(	const uint8_t *	data,
		size_t	dataLen
	)

static

The static method makes validation of input data

Parameters

[in]	data	The pointer to the beginning of byte stream of IP packet
[in]	dataLen	The length of byte stream

Returns: True if the data is valid and can represent the packet

◆ isSomeIpSdPort()

static bool pcpp::SomeIpSdLayer::isSomeIpSdPort ( uint16_t port )

inlinestatic

Checks if given port is a SOME/IP-SD protocol port

Parameters

[in] port Port to check

Returns: true if SOME/IP-SD protocol port, false if not

◆ setFlags()

void pcpp::SomeIpSdLayer::setFlags ( uint8_t flags )

Set the Flags of the layer

Parameters

[in] flags Flags to set

◆ toString()

std::string pcpp::SomeIpSdLayer::toString ( ) const

overridevirtual

Returns: The string representation of the SOME/IP-SD layer

Reimplemented from pcpp::SomeIpLayer.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SomeIpSdLayer() [1/2]

◆ SomeIpSdLayer() [2/2]

Member Function Documentation

◆ addEntry()

◆ addOptionTo()

◆ getEntries()

◆ getFlags()

◆ getNumEntries()

◆ getNumOptions()

◆ getOptions()

◆ getOptionsFromEntry()

◆ isDataValid()

◆ isSomeIpSdPort()

◆ setFlags()

◆ toString()