preCICE v3.1.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
precice::com::ConnectionInfoWriter Class Reference

Writes the connection info for the given participant/rank information. More...

#include <ConnectionInfoPublisher.hpp>

Inheritance diagram for precice::com::ConnectionInfoWriter:
[legend]
Collaboration diagram for precice::com::ConnectionInfoWriter:
[legend]

Public Member Functions

 ConnectionInfoWriter (std::string_view acceptorName, std::string_view requesterName, std::string_view tag, int rank, std::string_view addressDirectory) noexcept
 
 ConnectionInfoWriter (std::string_view acceptorName, std::string_view requesterName, std::string_view tag, std::string_view addressDirectory) noexcept
 
 ~ConnectionInfoWriter ()
 Removes the connection info file and the directories ./precice-run/[hash], is empty.
 
void write (std::string_view info) const
 Write the string info, e.g. IP:port to the connection info file.
 
- Public Member Functions inherited from precice::com::ConnectionInfoPublisher
 ConnectionInfoPublisher (std::string_view acceptorName, std::string_view requesterName, std::string_view tag, int rank, std::string_view addressDirectory) noexcept
 
 ConnectionInfoPublisher (std::string_view acceptorName, std::string_view requesterName, std::string_view tag, std::string_view addressDirectory) noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from precice::com::ConnectionInfoPublisher
std::string getLocalDirectory () const
 Returns the local directory which is used to store the hashed part.
 
std::string getFilename () const
 Returns the full path to the hashed filename.
 
- Protected Attributes inherited from precice::com::ConnectionInfoPublisher
std::string const acceptorName
 
std::string const requesterName
 
std::string const tag
 
int const rank = -1
 
std::string const addressDirectory
 
logging::Logger _log {"com::ConnectionInfoPublisher"}
 

Detailed Description

Writes the connection info for the given participant/rank information.

The file is removed, when the object is destroyed.

Definition at line 95 of file ConnectionInfoPublisher.hpp.

Constructor & Destructor Documentation

◆ ConnectionInfoWriter() [1/2]

precice::com::ConnectionInfoWriter::ConnectionInfoWriter ( std::string_view acceptorName,
std::string_view requesterName,
std::string_view tag,
int rank,
std::string_view addressDirectory )
inlinenoexcept

Definition at line 97 of file ConnectionInfoPublisher.hpp.

◆ ConnectionInfoWriter() [2/2]

precice::com::ConnectionInfoWriter::ConnectionInfoWriter ( std::string_view acceptorName,
std::string_view requesterName,
std::string_view tag,
std::string_view addressDirectory )
inlinenoexcept

Definition at line 106 of file ConnectionInfoPublisher.hpp.

◆ ~ConnectionInfoWriter()

precice::com::ConnectionInfoWriter::~ConnectionInfoWriter ( )

Removes the connection info file and the directories ./precice-run/[hash], is empty.

Definition at line 98 of file ConnectionInfoPublisher.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ write()

void precice::com::ConnectionInfoWriter::write ( std::string_view info) const

Write the string info, e.g. IP:port to the connection info file.

which is determined by acceptorName, requesterName, rank, addressDirectory set at construction.

Definition at line 122 of file ConnectionInfoPublisher.cpp.

Here is the call graph for this function:
The documentation for this class was generated from the following files: