Skip to content

Commit a9ab5d9

Browse files
committed
update readme
1 parent db078bc commit a9ab5d9

File tree

1 file changed

+42
-7
lines changed

1 file changed

+42
-7
lines changed

README.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,54 @@
11
# SimpleSocket
2-
Simple socket implementation for C++. Supports Windows and Linux.
2+
C++ библиотека неблокирующих сокетов (UDP/TCP) для Windows и Linux. Проектировалась для решения задач телеуправления и предполагает постоянное соединение двух устройств для передачи данных. Устойчива к разрывам соединения. Примеры использования: [udp_streamer](https://github.com/KirillHit/udp_streamer.git), [youbot_rc](https://github.com/KirillHit/youbot_rc.git).
33

4-
### Example
4+
## Demo
5+
В папке «demo» содержатся примеры кода сервера и клиента (UDP и TCP).
6+
7+
Сборка и запуск:
8+
9+
``` bash
10+
mkdir build
11+
cd build
12+
cmake -DDemo:=ON ..
13+
cmake --build .
14+
cd demo
15+
# First terminal
16+
.\tcp_server
17+
# second terminal
18+
.\tcp_client
19+
```
20+
21+
## Examples
522
``` c++
23+
// TCP server
624
#include "simple_socket/simple_socket.hpp"
7-
#include <vector>
825

926
int main()
1027
{
11-
sockets::UDPServer socket("127.0.0.1", 10000);
12-
socket_bind();
28+
sockets::TCPServer server;
29+
server.set_socket("127.0.0.1", 10000);
30+
server.set_keepalive(1, 1, 1);
31+
server.set_timeout(500);
32+
server.socket_bind();
33+
34+
server.receive(reinterpret_cast<char *>(&rx_msg), MSG_SIZE);
35+
server.send_mes(reinterpret_cast<char *>(&tx_msg), MSG_SIZE);
36+
37+
return 0;
38+
}
39+
```
1340

14-
std::vector<char> buf(65535);
41+
``` c++
42+
// TCP client
43+
#include "simple_socket/simple_socket.hpp"
44+
45+
int main()
46+
{
47+
sockets::TCPClient client;
48+
client.set_socket("127.0.0.1", 10000);
1549

16-
socket.receive(buf.data(), buf.size());
50+
client.send_mes(reinterpret_cast<char *>(&tx_msg), MSG_SIZE);
51+
client.receive(reinterpret_cast<char *>(&rx_msg), MSG_SIZE);
1752

1853
return 0;
1954
}

0 commit comments

Comments
 (0)