NetworkBrokerData.hpp

/*
Copyright (c) 2017-2026,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
Innovation LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
 
#include "gmlc/networking/addressOperations.hpp"
#include "gmlc/networking/interfaceOperations.hpp"
 
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
namespace helics {
 
class helicsCLI11App;
 
class NetworkBrokerData {
  public:
    enum class ServerModeOptions : char {
        UNSPECIFIED = 0,
        SERVER_DEFAULT_ACTIVE = 1,
        SERVER_DEFAULT_DEACTIVATED = 2,
        SERVER_ACTIVE = 3,
        SERVER_DEACTIVATED = 4,
    };
 
    std::string brokerName;  
    std::string brokerAddress;  
    std::string localInterface;  
    std::string brokerInitString;  
    std::string connectionAddress;  
    int portNumber{-1};  
    int brokerPort{-1};  
    int connectionPort{-1};  
 
    int portStart{-1};  
    int maxMessageSize{16 * 256};  
    int maxMessageCount{256};  
    int maxRetries{5};  
    gmlc::networking::InterfaceNetworks interfaceNetwork{
        gmlc::networking::InterfaceNetworks::LOCAL};
    bool reuse_address{false};  
    bool use_os_port{false};
    bool autobroker{false};  
    bool appendNameToAddress{false};
    bool noAckConnection{false};  
    bool useJsonSerialization{false};  
    bool observer{false};  
    ServerModeOptions server_mode{ServerModeOptions::UNSPECIFIED};  
    bool encrypted{false};  // enable encryption
    bool forceConnection{false};  // force the connection and terminate existing connections
    std::string encryptionConfig;
 
  public:
    NetworkBrokerData() = default;
    explicit NetworkBrokerData(gmlc::networking::InterfaceTypes type): allowedType(type) {}
 
    std::shared_ptr<helicsCLI11App> commandLineParser(std::string_view localAddress,
                                                      bool enableConfig = true);
    void setInterfaceType(gmlc::networking::InterfaceTypes type) { allowedType = type; }
 
  private:
    void checkAndUpdateBrokerAddress(std::string_view localAddress);
    gmlc::networking::InterfaceTypes allowedType{gmlc::networking::InterfaceTypes::IP};
};
 
}  // namespace helics