helics  3.3.0
TcpComms.h
1 /*
2 Copyright (c) 2017-2022,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
4 Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 #pragma once
8 
9 #include "../NetworkCommsInterface.hpp"
10 #include "gmlc/containers/BlockingQueue.hpp"
11 
12 #include <atomic>
13 #include <memory>
14 #include <set>
15 #include <string>
16 
17 namespace gmlc::networking {
18 class AsioContextManager;
19 class TcpConnection;
20 } // namespace gmlc::networking
21 
22 namespace helics::tcp {
23 
25 class TcpComms final: public NetworkCommsInterface {
26  public:
28  TcpComms() noexcept;
30  ~TcpComms();
32  virtual void loadNetworkInfo(const NetworkBrokerData& netInfo) override;
33 
34  virtual void setFlag(std::string_view flag, bool val) override;
35 
36  private:
37  bool reuse_address{false};
38  std::string encryption_config;
39  virtual int getDefaultBrokerPort() const override;
40  virtual void queue_rx_function() override;
41  virtual void queue_tx_function() override;
42 
43  virtual void closeReceiver() override;
44 
46  bool establishBrokerConnection(
47  std::shared_ptr<gmlc::networking::AsioContextManager>& ioctx,
48  std::shared_ptr<gmlc::networking::TcpConnection>& brokerConnection);
51  int processIncomingMessage(ActionMessage&& cmd);
52  // promise and future for communicating port number from tx_thread to rx_thread
53  gmlc::containers::BlockingQueue<ActionMessage> rxMessageQueue;
54 
55  void txReceive(const char* data, size_t bytes_received, const std::string& errorMessage);
56 
63  size_t dataReceive(gmlc::networking::TcpConnection* connection,
64  const char* data,
65  size_t bytes_received);
66 
67  // bool errorHandle()
68 };
69 
70 } // namespace helics::tcp
helics::CommsInterface::brokerTargetAddress
std::string brokerTargetAddress
the base for the broker address
Definition: CommsInterface.hpp:125
helics::CommsInterface::propertyLock
bool propertyLock()
Definition: CommsInterface.cpp:153
helics::tcp::TcpComms::TcpComms
TcpComms() noexcept
Definition: TcpComms.cpp:27
helics::NetworkCommsInterface::setFlag
virtual void setFlag(std::string_view flag, bool val) override
Definition: NetworkCommsInterface.cpp:209
helics::message_process_result::processed
@ processed
the message was used to update the current state
helics::CommsInterface::disconnecting
std::atomic< bool > disconnecting
flag indicating that the comm system is in the process of disconnecting
Definition: CommsInterface.hpp:158
helics::NetworkCommsInterface::PortNumber
std::atomic< int > PortNumber
port to use for the local connection
Definition: NetworkCommsInterface.hpp:60
helics::tcp::TcpComms::~TcpComms
~TcpComms()
Definition: TcpComms.cpp:64
helics::CommsInterface::brokerInitString
std::string brokerInitString
the initialization string for any automatically generated broker
Definition: CommsInterface.hpp:128
helics::NetworkBrokerData
Definition: NetworkBrokerData.hpp:23
helics::CommsInterface::connectionTimeout
std::chrono::milliseconds connectionTimeout
Definition: CommsInterface.hpp:146
helics::ActionMessage
Definition: ActionMessage.hpp:30
helics::NetworkCommsInterface::generateReplyToIncomingMessage
ActionMessage generateReplyToIncomingMessage(ActionMessage &cmd)
Definition: NetworkCommsInterface.cpp:226
helics::tcp::TcpComms::setFlag
virtual void setFlag(std::string_view flag, bool val) override
Definition: TcpComms.cpp:46
helics::CommsInterface::logError
void logError(std::string_view message) const
Definition: CommsInterface.cpp:581
helics::CommsInterface::txQueue
gmlc::containers::BlockingPriorityQueue< std::pair< route_id, ActionMessage > > txQueue
set of messages waiting to be transmitted
Definition: CommsInterface.hpp:155
helics::CommsInterface::CommsInterface
CommsInterface()=default
helics::tcp::TcpComms::loadNetworkInfo
virtual void loadNetworkInfo(const NetworkBrokerData &netInfo) override
Definition: TcpComms.cpp:35
TcpCommsCommon.h
helics::CommsInterface::logMessage
void logMessage(std::string_view message) const
Definition: CommsInterface.cpp:563
helics::NetworkCommsInterface::autoPortNumber
bool autoPortNumber
use an automatic port numbering based on broker responses
Definition: NetworkCommsInterface.hpp:61
helics::CommsInterface::ActionCallback
std::function< void(ActionMessage &&)> ActionCallback
the callback for what to do with a received message
Definition: CommsInterface.hpp:151
helics::CommsInterface::disconnect
void disconnect()
Definition: CommsInterface.cpp:385
helics::CommsInterface::logWarning
void logWarning(std::string_view message) const
Definition: CommsInterface.cpp:572
helics::NetworkCommsInterface::brokerPort
int brokerPort
standardized broker port to use for connection to the brokers
Definition: NetworkCommsInterface.hpp:59
helics::CommsInterface::localTargetAddress
std::string localTargetAddress
the base for the receive address
Definition: CommsInterface.hpp:124
helics::NetworkBrokerData::reuse_address
bool reuse_address
Definition: NetworkBrokerData.hpp:48
helics::CommsInterface::brokerName
std::string brokerName
Definition: CommsInterface.hpp:126
helics::prettyPrintString
std::string prettyPrintString(const ActionMessage &command)
Definition: ActionMessage.cpp:846
helics::isDisconnectCommand
bool isDisconnectCommand(const ActionMessage &command) noexcept
Definition: ActionMessage.hpp:277
helics::CommsInterface::requestDisconnect
std::atomic< bool > requestDisconnect
flag gets set when disconnect is called
Definition: CommsInterface.hpp:149
helics::NetworkCommsInterface::loadNetworkInfo
virtual void loadNetworkInfo(const NetworkBrokerData &netInfo) override
Definition: NetworkCommsInterface.cpp:97
helics::NetworkCommsInterface::noAckConnection
bool noAckConnection
flag to bypass the connection acknowledge requirement
Definition: NetworkCommsInterface.hpp:64
helics::tcp::TcpComms
Definition: TcpComms.h:25
helics::isProtocolCommand
bool isProtocolCommand(const ActionMessage &command) noexcept
Definition: ActionMessage.hpp:226
helics::CommsInterface::ConnectionStatus
ConnectionStatus
Definition: CommsInterface.hpp:107
helics::actionMessageType
const char * actionMessageType(action_message_def::action_t action)
Definition: ActionMessage.cpp:811
helics::NetworkCommsInterface::encrypted
bool encrypted
Definition: NetworkCommsInterface.hpp:65
helics::NetworkCommsInterface
Definition: NetworkCommsInterface.hpp:18
helics::CommsInterface::maxMessageSize
int maxMessageSize
the maximum message size for the queues (if needed)
Definition: CommsInterface.hpp:147
HELICS_CORE_TYPE_TCP
@ HELICS_CORE_TYPE_TCP
Definition: helics_enums.h:39