NetworkCommsInterface.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 "CommsInterface.hpp"
#include "helics/helics-config.h"
 
#include <map>
#include <set>
#include <string>
 
namespace helics {
class NetworkCommsInterface: public CommsInterface {
  private:
    class PortAllocator {
      public:
        PortAllocator();
        int findOpenPort(int count, std::string_view host = "localhost");
        void setStartingPortNumber(int startPort) { startingPort = startPort; }
        int getDefaultStartingPort() const { return startingPort; }
        void addUsedPort(int port);
        void addUsedPort(std::string_view host, int port);
 
      private:
        int startingPort = -1;
        std::map<std::string_view, std::set<int>> usedPort;
        std::map<std::string_view, int> nextPorts;
        bool isPortUsed(std::string_view host, int port) const;
        std::set<std::string> hosts;
        std::string_view addNewHost(std::string_view newHost);
    };
 
  public:
    explicit NetworkCommsInterface(gmlc::networking::InterfaceTypes type,
                                   CommsInterface::thread_generation threads =
                                       CommsInterface::thread_generation::dual) noexcept;
 
    virtual void loadNetworkInfo(const NetworkBrokerData& netInfo) override;
    void setBrokerPort(int brokerPortNumber);
    void setPortNumber(int localPortNumber);
    int getPortNumber() const { return PortNumber.load(); }
    void setAutomaticPortStartPort(int startingPort);
    virtual void setFlag(std::string_view flag, bool val) override;
 
  protected:
    int brokerPort{-1};  
    std::atomic<int> PortNumber{-1};  
    bool autoPortNumber{true};  
    bool useOsPortAllocation{false};  
    bool appendNameToAddress{false};  
    bool noAckConnection{false};  
    bool encrypted{false};  
    bool forceConnection{false};
    const gmlc::networking::InterfaceTypes networkType;
    gmlc::networking::InterfaceNetworks network{gmlc::networking::InterfaceNetworks::IPV4};
    std::atomic<bool> hasBroker{false};
    int maxRetries{5};  // the maximum number of network retries
 
  private:
    PortAllocator openPorts;  
 
  public:
    int findOpenPort(int count, std::string_view host);
    ActionMessage generateReplyToIncomingMessage(ActionMessage& cmd);
 
  public:
    int getPort() const { return PortNumber; }
    std::string getAddress() const;
    virtual int getDefaultBrokerPort() const = 0;
 
  protected:
    ActionMessage generatePortRequest(int cnt = 1) const;
    void loadPortDefinitions(const ActionMessage& cmd);
};
 
}  // namespace helics