Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Beardsworth <beardsworth@intrinsic.ai>
  • Loading branch information
mbeards committed May 6, 2024
1 parent cfd75cf commit 6523465
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions include/gz/transport/Discovery.hh
Original file line number Diff line number Diff line change
Expand Up @@ -760,6 +760,8 @@ namespace gz
this->relayAddrs.push_back(addr);
}

// \brief Gets this instance's relay addresses.
// \return The list of relay addresses.
public: std::vector<std::string> RelayAddresses() const
{
std::vector<std::string> result;
Expand Down
12 changes: 11 additions & 1 deletion include/gz/transport/Node.hh
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,17 @@ namespace gz
public: std::optional<TopicStatistics> TopicStats(
const std::string &_topic) const;

public: void AddGlobalRelay(const std::string& relay_address);
/// \brief Adds a unicast relay IP. All nodes in this process will send
/// UDP unicast traffic to the address to connect networks when UDP
/// multicast traffic is not forwarded.
/// It's also possible to use the environment variable GZ_RELAY to add
/// relays.
/// \param[in] _relayAddress IPv4 address of the relay to add.
public: void AddGlobalRelay(const std::string& _relayAddress);

/// \brief Gets the relay addresses configured for all nodes in this
/// process.
/// \return The relay addresses.
public: std::vector<std::string> GlobalRelays() const;

/// \brief Get a pointer to the shared node (singleton shared by all the
Expand Down

0 comments on commit 6523465

Please sign in to comment.