BaosTcpConnection.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_TCPCONNECTION_H__
#define __BAOSLIB_TCPCONNECTION_H__
 
#include "baos/config.h"
#include "baos/connection/BaosConnection.h"
#include "baos/transport/TransportTcpIO.h"
 
namespace wz::baos::transport
{
class ProtocolStack;
}
 
namespace wz::baos::ip
{
 
/**********************************************************
 * Base BaosTcpConnection
 ***********************************************************/
 
namespace base
{
class BAOSLIB_EXPORT BaosTcpConnection : public BaosConnection
{
public:
    using UPtr              = std::unique_ptr<BaosTcpConnection>;  
    using TcpTransportFrame = Buffer;                              
 
    BaosTcpConnection();
 
 
    BaosTcpConnection(std::unique_ptr<ip::Ip4Driver>& driver);
 
    virtual ~BaosTcpConnection();
 
    void enableEnsureAutoConnect(bool enable);
 
    void enableVerifyProtocolVersion(bool enable);
 
    void open(const std::string& ip4Address, std::uint16_t port = 12004);
    void reopen() override;
 
protected:
    virtual void postOpen(protocol::ResponsePromise&& prom);
 
    bool isOpenImpl() override;
 
    protocol::ResponseFuture closeImplAsync() override;
    void startImpl() override;
 
    void eventHandler();
 
    void handleRxTcp(IOEvent&& event);
 
    void handleTxTcp(IOEvent&& event);
 
    protocol::ResponseFuture sendImpl(BaosFrame&& frame) override;
    void onStateChange(State oldState, State newState) override;
 
    void resolveMsgQPromises(std::exception_ptr eptr) noexcept;
 
    transport::TransportTcpIO& getTransportIO();
 
protected:
    transport::TransportTcpIO::UPtr transportIO_;
    ip::Ip4SocketAddress socketAddress_;
    std::uint64_t msgId_{0};
    bool ensureAutoConnect_{true}; 
    bool verifyProtocolVersion_{true}; 
};
 
}  // namespace base
 
/***************************************************************
 * BaosConLessTcpConnection
 ***************************************************************/
 
class BAOSLIB_EXPORT BaosConLessTcpConnection : public base::BaosTcpConnection
{
public:
    using UPtr = std::unique_ptr<BaosConLessTcpConnection>;  
 
    BaosConLessTcpConnection();
    BaosConLessTcpConnection(std::unique_ptr<ip::Ip4Driver>& driver);
 
    virtual ~BaosConLessTcpConnection();
 
};
 
using BaosTcpConnection = BaosConLessTcpConnection;
 
/***************************************************************
 * BaosConOrientedTcpConnection
 ***************************************************************/
 
class BAOSLIB_EXPORT BaosConOrientedTcpConnection : public base::BaosTcpConnection
{
public:
    using UPtr = std::unique_ptr<BaosConOrientedTcpConnection>;  
 
    BaosConOrientedTcpConnection();
    BaosConOrientedTcpConnection(std::unique_ptr<ip::Ip4Driver>& driver);
 
    virtual ~BaosConOrientedTcpConnection();
 
};
 
/***************************************************************
 * BaosSecureTcpConnection
 ***************************************************************/
 
class BAOSLIB_EXPORT BaosSecureTcpConnection : public base::BaosTcpConnection
{
public:
    using UPtr = std::unique_ptr<BaosSecureTcpConnection>;  
    using PasswordHash = std::array<std::uint8_t, 16>;
    using AuthenticationCode = std::array<std::uint8_t, 16>;
 
    BaosSecureTcpConnection();
    BaosSecureTcpConnection(std::unique_ptr<ip::Ip4Driver>& driver);
 
    virtual ~BaosSecureTcpConnection();
 
    void open(const std::string& ip4Address, 
        const PasswordHash& passwordHash, 
        std::uint16_t port = 12004);
 
    void open(const std::string& ip4Address, 
        const PasswordHash& passwordHash, const AuthenticationCode& authenticationCode,
        std::uint16_t port = 12004);
 
    static PasswordHash calculatePasswordHash(const std::string& password);
    static AuthenticationCode calculateDeviceAuthenticationCode(const std::string& secret);
 
protected:
    void postOpen(protocol::ResponsePromise&& prom) override;
 
private:
    PasswordHash passwordHash_;
    std::optional<AuthenticationCode> authenticationCode_;
 
};
 
}  // namespace wz::baos::ip
 
#endif  // __BAOSLIB_TCPCONNECTION_H__