KnxNetIPPacketizer Class Reference

Specializaton for a Packetizer which detects KnxNet/Ip packets. More...

#include <baos/ip/TcpIO.h>

Inheritance diagram for KnxNetIPPacketizer:

Public Types
using	UPtr = std::unique_ptr< KnxNetIPPacketizer >
	Alias for a std::unique_ptr to this class.
Public Types inherited from PacketizerBase
using	UPtr = std::unique_ptr< PacketizerBase >
	Alias for a std::unique_ptr to this class.

Public Member Functions
	KnxNetIPPacketizer ()
	Construct a new Knx Net IP Packetizer object with given pattern. size position and length.
bool	packetize (const Buffer &buf, std::uint16_t bufferSize, std::int32_t &offset, std::uint16_t &length) override
void	setAcceptedProtocolVersions (const std::vector< std::uint8_t > &versions)
Public Member Functions inherited from PacketizerBase
	PacketizerBase (const Buffer &startPattern, std::uint16_t sizePosition, std::uint16_t sizeBytes)
	Construct a new Packetizer Base object from a given pattern. More...

Protected Attributes
std::vector< std::uint8_t >	acceptedProtocolVersions_ {0x10,0x20}
Protected Attributes inherited from PacketizerBase
const Buffer	startPattern_
	The pattern which marks the beginning of a packet in the byte stream.
const std::int32_t	sizePosition_ {-1}
	The 0 based index of the total size information in packet.
const std::uint16_t	sizeBytes_ {0}
	From how many bytes is the total size composed.

Static Protected Attributes
constexpr static std::uint8_t	HEADER_SIZE {6}
	The size of the KNXnet/IP header.
constexpr static std::uint8_t	PROTOCOL_VERSION_POSITION {1}
	The position of the protocol version byte inside the KNXnet/IP header.

Detailed Description

Specializaton for a Packetizer which detects KnxNet/Ip packets.

Member Function Documentation

packetize()

bool packetize ( const Buffer &  buf, std::uint16_t  bufferSize, std::int32_t &  offset, std::uint16_t &  length  )

overridevirtual

Parameters

buf	reference to the buffer in which the packet should be found
bufferSize	the actual size of the buffer
offset	[out] if a packet was found the start offset of it
length	[out] if a packet was found the length of the packet(overall)

Returns

true if packet was found false otherwise

Implements PacketizerBase.

---

The documentation for this class was generated from the following file:

• TcpIO.h