Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KuangjuX-Archived/TrivalTCPStack
:bangbang: A TCP protocol library in user mode implmented in pure C.
https://github.com/KuangjuX-Archived/TrivalTCPStack
Last synced: 2 months ago
JSON representation
:bangbang: A TCP protocol library in user mode implmented in pure C.
- Host: GitHub
- URL: https://github.com/KuangjuX-Archived/TrivalTCPStack
- Owner: KuangjuX-Archived
- License: gpl-3.0
- Archived: true
- Created: 2021-08-17T03:25:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-09T12:14:40.000Z (over 3 years ago)
- Last Synced: 2024-08-11T09:01:03.669Z (5 months ago)
- Language: C
- Homepage:
- Size: 27 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TrivialTCP
**TrivialTCP is an open source TCP library in user mode implmented in pure C.**
We use UDP to simulate the IP layer of the kernel to send and receive packets. **TrivialTCP** is the core part of this project, which can send and receive reliably.
Otherwise, we have also implemented high-performance components such as thread pools, epolls, and coroutines in user mode.
At the top layer, we expose APIs similar to the POSIX standard to users, so that we can provide reliable transmission services for applications.
## Requirements
- GCC
- Dokcer
## Start
In project directory, we can execute following command:
```shell
docker build -t tcp .
```
So we have a docker image named tcp.
As follow, we have to create my own network configuration:
```shell
docker network create --subnet=10.0.0.0/16 mynetwork
```
Before create the server/client containers, you should know the **absolute path** of this project in your computer.
You can use the `pwd` command to get the path.
And then we can run our container by static ip address and bind this project in a double-way between your host and containers:
**NOTICE!** Replace {project path on your host} by your path:
```shell
sudo docker run --cap-add NET_ADMIN -itd -p 22 --name server --net mynetwork --ip 10.0.0.3 --hostname server -v {project path on your host}:/tjutcp tcp /bin/bash
sudo docker run --cap-add NET_ADMIN -itd -p 22 --name client --net mynetwork --ip 10.0.0.2 --hostname client -v {project path on your host}:/tjutcp tcp /bin/bash
```
The following commands could attach you in to each container:
````shell
sudo docker exec -it client /bin/bash
sudo docker exec -it server /bin/bash
````
execute `make server` in server container and execute `make client` in client container under the `/tjutcp` folder, we can run the project easily.
## Workflows:
- [x] Environment
- [x] Thread Pool
- [x] Channel
- [x] Coroutine
- [ ] Epoll
- [x] Connection Management
- [x] Timer
- [x] System API: bind, listen, accept, connect, recv, send, close
- [x] Reliable Transmission
- [x] Flow Control
- [x] Congestion Control
## Differnes
We use `10.0.0.3` as server's ip address instead of `10.0.0.1` because this address is reported occupied.
## Other
- Once create the containers by the params `-itd`, they keep running in the background.
- Get more information on the Docker website.
Destroy all running containers:
```shell
sudo docker container prune
```
- Use valgrind to check the status of memory leak:
```shell
valgrind --tool=memcheck (--leak-check=full) {exectuable file}
```
## References
- RFC 793
- RFC 1122
- RFC 5681
- RFC 6298
- [C-Thread-Pool](https://github.com/Pithikos/C-Thread-Pool)
- [chan](https://github.com/tylertreat/chan)
- [libaco](https://github.com/hnes/libaco)