Table of Contents
The primary intention of writing this project is to give an overview of how one can entertain multiple client requests to a server in parallel. In this project a TCP/IP server is created. The server can receive multiple client requests at the same time and entertain each client request in parallel so that no client will have to wait for server time.
The TCP/IP server has been designed with multi-threading for parallel processing. The server itself is defined as a class. There is another class called myThread that handles the multi-threading mecanism. A special processor derived class (ProcessSingleClient) to just handle a client that sends a clock time information to the server.
-
First of all, the server is initialized then bound to a specific port number
-
Next, the server starts listenning to a new connexion
-
A new accepted client will get a thread allocated to it and start exhanging with the server
-
Parallelly the server will still be listenng to a new connexion
-
Logs are generated for both server and client using the boost log library
-
Also the command to pass the option to the main function use the boost program_options library
A list of commonly used resources that I find helpful are listed in the acknowledgements.
This is an sample code of how to implement a single server mutilple clients communication mutli-threading.
To get a local copy up and running follow these simple steps.
.
├── CMakeLists.txt
├── include
│ ├── GetLocalAddress.h
│ ├── Manager.h
│ ├── MyClient.h
│ ├── MyProcessor.h
│ ├── MyServer.h
│ ├── MyThread.h
│ └── ProcessSingleClient.h
├── README.md
└── src
├── demo
│ ├── CMakeLists.txt
│ ├── demoClient
│ │ └── demoClient.cpp
│ └── demoServer
│ └── demoServer.cpp
└── lib
├── CMakeLists.txt
├── myClient
│ └── MyClient.cpp
└── myServer
├── GetLocalAddress.cpp
├── MyProcessor.cpp
├── MyServer.cpp
├── MyThread.cpp
└── ProcessSingleClient.cpp
8 directories, 19 files
This is an example of how to list things you need to use the software and how to install them.
-
cmake
sudo apt-get install cmake
-
cd /opt mkdir boost sudo apt-get -y install build-essential g++ python-dev autotools-dev libicu-dev libbz2-dev wget http://downloads.sourceforge.net/project/boost/boost/1.76.0/boost_1_76_0.tar.gz tar -zxvf boost_1_76_0.tar.gz cd boost_1_76_0 # get the no of cpucores to make faster cpuCores=`cat /proc/cpuinfo | grep "cpu cores" | uniq | awk '{print $NF}'` echo "Available CPU cores: "$cpuCores ./bootstrap.sh # this will generate ./b2 sudo ./b2 --with=all -j $cpuCores install
-
Check boost version
cat /usr/local/include/boost/version.hpp | grep "BOOST_LIB_VERSION"- Result
// BOOST_LIB_VERSION must be defined to be the same as BOOST_VERSION
#define BOOST_LIB_VERSION "1_76_0"- Clone the repo
git clone https://github.com/zoumson/Multi-ClientServer.git
- Go to the project directory source
cd Multi-ClientServer - Create empty directories
mkdir build && mkdir bin && mkdir log && mkdir lib
- Generate the executables and move them to
bincd build && cmake .. && make -j4 && cd ..
Command line arguments
- Sever side
- Command parser using boost program_options
Usage: options_description [options]
Allowed options:
-h [ --help ] produce help message
-p [ --port ] [=arg(=60000)] (=no) server port number.
-c [ --connexion ] [=arg(=10)] (=few) server max connexion.
-l [ --log ] [=arg(=server.log)] (=server.log)
server log name
- Dafaut server port number: random available port from host
./server
- Implicit server port number: 60000
./server -p
- Self defined server port number: myPort
./server -p myPort
- Server log:
2021_05_28_02_08_11_server.log - Sample server log
[2021-05-28 02:08:11]<6>: Server IP: [192.168.1.106]
[2021-05-28 02:08:11]<6>: Server max connexion: [5]
[2021-05-28 02:08:11]<6>: Creating a server socket ...
[2021-05-28 02:08:11]<6>: A client socket created
[2021-05-28 02:08:11]<6>: Binding to a local port ...
[2021-05-28 02:08:11]<6>: Bind success
[2021-05-28 02:08:11]<6>: Server Port Number: [60000]
[2021-05-28 02:08:11]<6>: Listenning to a new connexion...
[2021-05-28 02:08:11]<6>: A client connected to a server
[2021-05-28 02:08:11]<6>: Accepting a connexion...
[2021-05-28 02:08:42]<6>: Connexion accepted
[2021-05-28 02:08:42]<6>: Client IP: [192.168.1.106]
[2021-05-28 02:08:42]<6>: Client Port Number: [49034]
[2021-05-28 02:08:42]<6>: Accepting a connexion...
[2021-05-28 02:08:42]<6>: Time received from the client 6: 02:08:42
[2021-05-28 02:08:48]<6>: Time received from the client 6: 02:08:48
[2021-05-28 02:08:54]<6>: Time received from the client 6: 02:08:54
[2021-05-28 02:09:00]<6>: Time received from the client 6: 02:09:00
[2021-05-28 02:09:06]<6>: Time received from the client 6: 02:09:06
[2021-05-28 02:09:12]<6>: Time received from the client 6: 02:09:12
[2021-05-28 02:09:18]<6>: Connexion accepted
[2021-05-28 02:09:18]<6>: Client IP: [192.168.1.106]
[2021-05-28 02:09:18]<6>: Client Port Number: [49036]
[2021-05-28 02:09:18]<6>: Accepting a connexion...
[2021-05-28 02:09:18]<6>: Time received from the client 7: 02:09:18
[2021-05-28 02:09:18]<6>: Time received from the client 6: 02:09:18
[2021-05-28 02:09:24]<6>: Time received from the client 7: 02:09:24
[2021-05-28 02:09:24]<6>: Time received from the client 6: 02:09:24
[2021-05-28 02:09:30]<6>: Closing connexion with client: 7
[2021-05-28 02:09:30]<6>: A Server closing an accpeted connexion ...
[2021-05-28 02:09:30]<6>: Accepted connexion closed
[2021-05-28 02:09:30]<6>: Time received from the client 6: 02:09:30
[2021-05-28 02:09:36]<6>: Closing connexion with client: 6
[2021-05-28 02:09:36]<6>: A Server closing an accpeted connexion ...
[2021-05-28 02:09:36]<6>: Accepted connexion closed
- Client side
- Command parser using boost program_options
Usage: options_description [options]
Allowed options:
-h [ --help ] produce help message
-i [ --ip ] arg server IP address
-p [ --port ] arg server port number.
-l [ --log ] [=arg(=client.log)] (=client.log)
client log path
- Client log:
2021_05_28_02_08_42_client.log - Sample client log
[2021-05-28 02:08:42]<6>: A Client sending a request ... [2021-05-28 02:08:42]<6>: Request sent to a server [2021-05-28 02:08:42]<6>: A Client receiving a response ... [2021-05-28 02:08:42]<6>: Response from a server [2021-05-28 02:08:42]<6>: sucess [2021-05-28 02:08:48]<6>: A Client sending a request ... [2021-05-28 02:08:48]<6>: Request sent to a server [2021-05-28 02:08:48]<6>: A Client receiving a response ... [2021-05-28 02:08:48]<6>: Response from a server [2021-05-28 02:08:48]<6>: sucess [2021-05-28 02:08:54]<6>: A Client sending a request ... [2021-05-28 02:08:54]<6>: Request sent to a server [2021-05-28 02:08:54]<6>: A Client receiving a response ... [2021-05-28 02:08:54]<6>: Response from a server [2021-05-28 02:08:54]<6>: sucess [2021-05-28 02:09:00]<6>: A Client sending a request ... [2021-05-28 02:09:00]<6>: Request sent to a server [2021-05-28 02:09:00]<6>: A Client receiving a response ... [2021-05-28 02:09:00]<6>: Response from a server [2021-05-28 02:09:00]<6>: sucess [2021-05-28 02:09:06]<6>: A Client sending a request ... [2021-05-28 02:09:06]<6>: Request sent to a server [2021-05-28 02:09:06]<6>: A Client receiving a response ... [2021-05-28 02:09:06]<6>: Response from a server [2021-05-28 02:09:06]<6>: sucess [2021-05-28 02:09:12]<6>: A Client sending a request ... [2021-05-28 02:09:12]<6>: Request sent to a server [2021-05-28 02:09:12]<6>: A Client receiving a response ... [2021-05-28 02:09:12]<6>: Response from a server [2021-05-28 02:09:12]<6>: sucess [2021-05-28 02:09:18]<6>: A Client sending a request ... [2021-05-28 02:09:18]<6>: Request sent to a server [2021-05-28 02:09:18]<6>: A Client receiving a response ... [2021-05-28 02:09:18]<6>: Response from a server [2021-05-28 02:09:18]<6>: sucess [2021-05-28 02:09:24]<6>: A Client sending a request ... [2021-05-28 02:09:24]<6>: Request sent to a server [2021-05-28 02:09:24]<6>: A Client receiving a response ... [2021-05-28 02:09:24]<6>: Response from a server [2021-05-28 02:09:24]<6>: sucess [2021-05-28 02:09:30]<6>: A Client sending a request ... [2021-05-28 02:09:30]<6>: Request sent to a server [2021-05-28 02:09:30]<6>: A Client receiving a response ... [2021-05-28 02:09:30]<6>: Response from a server [2021-05-28 02:09:30]<6>: sucess- Back to the initial file structure configuration
rm -r bin build log lib
All the headers files are well docummented, read through the comments
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Adama Zouma - - stargue49@gmail.com
Project Link: https://github.com/zoumson/Multi-ClientServer