Skip to content

Commit

Permalink
Add parameter documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fmauch committed Sep 6, 2023
1 parent 3aa0a41 commit c4d39c3
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion include/ur_client_library/comm/tcp_server.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,16 @@ class TCPServer
{
public:
TCPServer() = delete;
TCPServer(const int port, const size_t max_num_tries = 0,
/*!
* \brief Create a TCPServer object
*
* \param port Port on which to operate. The port will be bound to the process creating the
* object.
* \param max_num_tries If binding the socket fails, it will be retried this many times. If 0 is
* specified, binding the socket will be tried indefinitely.
* \param reconnection_time Wait time in between binding attempts.
*/
explicit TCPServer(const int port, const size_t max_num_tries = 0,
const std::chrono::milliseconds reconnection_time = std::chrono::seconds(1));
virtual ~TCPServer();

Expand Down

0 comments on commit c4d39c3

Please sign in to comment.