Public Member Functions | Private Member Functions | Private Attributes | List of all members
TCPSocketTest::Client Class Reference
Inheritance diagram for TCPSocketTest::Client:
Inheritance graph
[legend]

Public Member Functions

 Client (int port, const std::string &ip="127.0.0.1")
 
bool setup (const size_t max_num_tries=0, const std::chrono::milliseconds reconnection_time=std::chrono::seconds(10))
 
void setupClientBeforeServer (const size_t max_num_tries=0, const std::chrono::milliseconds reconnection_time=std::chrono::seconds(10))
 
bool waitForClientSetupThread ()
 
- Public Member Functions inherited from urcl::comm::TCPSocket
void close ()
 Closes the connection to the socket. More...
 
std::string getIP () const
 Determines the local IP address of the currently configured socket. More...
 
socket_t getSocketFD ()
 Getter for the file descriptor of the socket. More...
 
SocketState getState ()
 Getter for the state of the socket. More...
 
bool read (char *character)
 Reads one byte from the socket. More...
 
bool read (uint8_t *buf, const size_t buf_len, size_t &read)
 Reads data from the socket. More...
 
void setReceiveTimeout (const timeval &timeout)
 Setup Receive timeout used for this socket. More...
 
void setReconnectionTime (const std::chrono::milliseconds reconnection_time)
 Set reconnection time, if the server is unavailable during connection this will set the time before trying connect to the server again. More...
 
 TCPSocket ()
 Creates a TCPSocket object. More...
 
bool write (const uint8_t *buf, const size_t buf_len, size_t &written)
 Writes to the socket. More...
 
virtual ~TCPSocket ()
 

Private Member Functions

void setupClient (int port, const size_t max_num_tries=0, std::chrono::milliseconds reconnection_time=std::chrono::seconds(10))
 

Private Attributes

std::thread client_setup_thread_
 
bool done_setting_up_client_
 
std::string ip_
 
int port_
 

Additional Inherited Members

- Static Public Attributes inherited from urcl::comm::TCPSocket
static constexpr std::chrono::milliseconds DEFAULT_RECONNECTION_TIME { 10000 }
 
- Protected Member Functions inherited from urcl::comm::TCPSocket
bool setup (const std::string &host, const int port, const size_t max_num_tries=0, const std::chrono::milliseconds reconnection_time=DEFAULT_RECONNECTION_TIME)
 
- Static Protected Member Functions inherited from urcl::comm::TCPSocket
static bool open (socket_t socket_fd, struct sockaddr *address, size_t address_len)
 
- Protected Attributes inherited from urcl::comm::TCPSocket
std::unique_ptr< timeval > recv_timeout_
 

Detailed Description

Definition at line 106 of file test_tcp_socket.cpp.

Constructor & Destructor Documentation

◆ Client()

TCPSocketTest::Client::Client ( int  port,
const std::string &  ip = "127.0.0.1" 
)
inline

Definition at line 109 of file test_tcp_socket.cpp.

Member Function Documentation

◆ setup()

bool TCPSocketTest::Client::setup ( const size_t  max_num_tries = 0,
const std::chrono::milliseconds  reconnection_time = std::chrono::seconds(10) 
)
inline

Definition at line 115 of file test_tcp_socket.cpp.

◆ setupClient()

void TCPSocketTest::Client::setupClient ( int  port,
const size_t  max_num_tries = 0,
std::chrono::milliseconds  reconnection_time = std::chrono::seconds(10) 
)
inlineprivate

Definition at line 152 of file test_tcp_socket.cpp.

◆ setupClientBeforeServer()

void TCPSocketTest::Client::setupClientBeforeServer ( const size_t  max_num_tries = 0,
const std::chrono::milliseconds  reconnection_time = std::chrono::seconds(10) 
)
inline

Definition at line 121 of file test_tcp_socket.cpp.

◆ waitForClientSetupThread()

bool TCPSocketTest::Client::waitForClientSetupThread ( )
inline

Definition at line 128 of file test_tcp_socket.cpp.

Member Data Documentation

◆ client_setup_thread_

std::thread TCPSocketTest::Client::client_setup_thread_
private

Definition at line 147 of file test_tcp_socket.cpp.

◆ done_setting_up_client_

bool TCPSocketTest::Client::done_setting_up_client_
private

Definition at line 150 of file test_tcp_socket.cpp.

◆ ip_

std::string TCPSocketTest::Client::ip_
private

Definition at line 149 of file test_tcp_socket.cpp.

◆ port_

int TCPSocketTest::Client::port_
private

Definition at line 148 of file test_tcp_socket.cpp.


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


ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Mon May 26 2025 02:35:58