BAOS SDK v2  1.0.1
An SDK providing access to IP-BAOS devices through BAOS binary protocol version 2.x
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
 
- 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...
 

Additional Inherited Members

- 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.
 

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
bufreference to the buffer in which the packet should be found
bufferSizethe 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: