helics  3.5.2
Public Member Functions | Protected Member Functions | List of all members
helics::tcp::TcpCoreSS Class Referencefinal

#include <TcpCore.h>

+ Inheritance diagram for helics::tcp::TcpCoreSS:

Public Member Functions

 TcpCoreSS () noexcept
 
 TcpCoreSS (std::string_view coreName)
 
- Public Member Functions inherited from helics::NetworkCore< TcpCommsSS, InterfaceTypes::TCP >
 NetworkCore () noexcept
 
 NetworkCore (std::string_view broker_name)
 
virtual std::string generateLocalAddressString () const override
 
- Public Member Functions inherited from helics::CommsBroker< COMMS, BrokerT >
 CommsBroker () noexcept
 
 CommsBroker (bool arg) noexcept
 
 CommsBroker (std::string_view obj_name)
 
 ~CommsBroker ()
 
virtual void transmit (route_id rid, const ActionMessage &cmd) override
 
virtual void transmit (route_id rid, ActionMessage &&cmd) override
 
virtual void addRoute (route_id rid, int interfaceId, std::string_view routeInfo) override
 
virtual void removeRoute (route_id rid) override
 
COMMS * getCommsObjectPointer ()
 

Protected Member Functions

virtual std::shared_ptr< helicsCLI11AppgenerateCLI () override
 

Additional Inherited Members

- Protected Attributes inherited from helics::NetworkCore< TcpCommsSS, InterfaceTypes::TCP >
std::mutex dataMutex
 mutex protecting the configuration information
 
NetworkBrokerData netInfo
 structure containing the networking information
 
- Protected Attributes inherited from helics::CommsBroker< COMMS, BrokerT >
std::atomic< int > disconnectionStage {0}
 the stage of disconnection
 
std::unique_ptr< COMMS > comms
 the actual comms object
 
std::atomic< bool > brokerInitialized {false}
 atomic protecting local initialization
 

Detailed Description

implementation for the core that uses tcp messages to communicate

Constructor & Destructor Documentation

◆ TcpCoreSS()

helics::tcp::TcpCoreSS::TcpCoreSS ( )
noexcept

default constructor

Member Function Documentation

◆ generateCLI()

std::shared_ptr< helicsCLI11App > helics::tcp::TcpCoreSS::generateCLI ( )
overrideprotectedvirtual

generate a CLI11 Application for subprocesses for processing of command line arguments

Reimplemented from helics::NetworkCore< TcpCommsSS, InterfaceTypes::TCP >.

References helics::NetworkCore< COMMS, baseline >::generateCLI().


The documentation for this class was generated from the following files: