BaosIpv4Device.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_IPV4INTERFACE_H__
#define __BAOSLIB_IPV4INTERFACE_H__
 
 
#include "baos/config.h"
#include "baos/device/BaosDevice.h"
#include "baos/protocol/Defines.h"
 
#include <memory>
#include <optional>
#include <utility>
 
 
namespace wz::baos::ip
{
/*******************************************
 * BaosIp4Device
 *******************************************/
 
class BAOSLIB_EXPORT BaosIp4Device : public wz::baos::BaosDevice
{
public:
    virtual ~BaosIp4Device() = default;
 
    BaosIp4Device(const std::string& ip4Address, std::uint16_t port = 12004);
 
    void setConnectionData(const std::string& ip4Address, std::uint16_t port = 12004);
 
    BaosConnection_UPtr getConnection() override;
 
    void enableEnsureAutoConnect(bool enable);
 
    void enableVerifyProtocolVersion(bool enable);
 
protected:
    std::string ip4Address_;
    std::uint16_t port_;
    bool ensureAutoConnect_{true}; 
    bool verifyProtocolVersion_{true}; 
};
 
 
using BaosConLessIp4Device = BaosIp4Device;
 
class BAOSLIB_EXPORT BaosConOrientedIp4Device : public BaosIp4Device
{
public:
    virtual ~BaosConOrientedIp4Device() = default;
 
    BaosConOrientedIp4Device(const std::string& ip4Address, std::uint16_t port = 12004);
 
    BaosConnection_UPtr getConnection() override;
};
 
class BAOSLIB_EXPORT BaosSecureIp4Device : public BaosIp4Device
{
public:
    using PasswordHash = std::array<std::uint8_t, 16>;
    using AuthenticationCode = std::array<std::uint8_t, 16>;
 
    virtual ~BaosSecureIp4Device() = default;
 
    BaosSecureIp4Device(const std::string& ip4Address, const PasswordHash& passwordHash,
        std::uint16_t port = 12004);
 
    BaosSecureIp4Device(const std::string& ip4Address, const PasswordHash& passwordHash,
        const AuthenticationCode& authenticationCode, std::uint16_t port = 12004);
 
    BaosConnection_UPtr getConnection() override;
    
    void setConnectionData(const std::string& ip4Address, const PasswordHash& passwordHash,
         std::uint16_t port = 12004);
 
    void setConnectionData(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);
 
private:
    PasswordHash passwordHash_;
    std::optional<AuthenticationCode> authenticationCode_;
};
 
}  // namespace wz::baos::ip
 
#endif  // __BAOSLIB_IPV4INTERFACE_H__