TcpIO.h

Go to the documentation of this file.

//
// Copyright (c) 2002-2026 WEINZIERL ENGINEERING GmbH
// All rights reserved.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,
// WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
//
 
#ifndef __BAOSLIB_TCP_IO_H__
#define __BAOSLIB_TCP_IO_H__
 
#include "baos/BaosLib_export.h"
#include "baos/config.h"
#include "baos/connection/IOEvent.h"
 
#include "wzcpp/features/concurrent/executor.h"
 
#include <array>
#include <atomic>
#include <memory>
#include <string>
 
 
namespace wz::baos::ip
{
 
class Ip4Driver;
 
class BAOSLIB_EXPORT PacketizerBase
{
public:
    using UPtr       = std::unique_ptr<PacketizerBase>;  
    PacketizerBase() = delete;
 
    PacketizerBase(const Buffer& startPattern, std::uint16_t sizePosition, std::uint16_t sizeBytes);
 
    virtual ~PacketizerBase() = default;
 
    virtual bool packetize(const Buffer& buf,
                           std::uint16_t bufferSize,
                           std::int32_t& offset,
                           std::uint16_t& length) = 0;
 
protected:
    const Buffer startPattern_;            
    const std::int32_t sizePosition_{-1};  
    const std::uint16_t sizeBytes_{0};     
};
 
class BAOSLIB_EXPORT KnxNetIPPacketizer : public PacketizerBase
{
public:
    using UPtr = std::unique_ptr<KnxNetIPPacketizer>;  
 
    KnxNetIPPacketizer();
 
    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);
 
protected:
    constexpr static std::uint8_t HEADER_SIZE{6};  
    constexpr static std::uint8_t PROTOCOL_VERSION_POSITION{1};  
    std::vector<std::uint8_t> acceptedProtocolVersions_{0x10,0x20};
};
 
 
/******************************************************************
 * TcpIO
 ******************************************************************/
 
class BAOSLIB_EXPORT TcpIO
{
public:
    using UPtr       = std::unique_ptr<TcpIO>;        
    using UniqueLock = std::unique_lock<std::mutex>;  
 
    TcpIO(BaosMsgQueue& msgQueue, wzcpp::ExecutorBase& executor);
 
 
    TcpIO(BaosMsgQueue& msgQueue, std::unique_ptr<Ip4Driver>& driver, wzcpp::ExecutorBase& executor);
 
    Ip4Driver& getDriver();
 
    ~TcpIO();
 
    void send(const Buffer& buf);
 
    void open(const std::string& ip4Address, std::uint16_t port);
 
    void close();
 
    void waitForFinished();
 
    bool isOpen();
 
private:
    void rxHandler();
 
protected:
    static std::atomic<std::uint64_t> msgId;  
    std::atomic<bool> rxShouldStop_{false};   
    std::condition_variable cvFinished_;      
    mutable std::mutex cvFinished_mut_;       
    bool stopped_{false};                     
 
    std::atomic<bool> isOpen_{false};  
    BaosMsgQueue& msgQueue_;           
    wzcpp::ExecutorBase& executor_;    
    std::unique_ptr<Ip4Driver> driver_;       
    PacketizerBase::UPtr packetizer_;  
};
 
}  // namespace wz::baos::ip
 
#endif  //__BAOSLIB_TCP_IO_H__