Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/p4zd4n/distributed-averaging-system
App to calculate the average of collected from various instances numerical data and to transfer it between devices in the local network using UDP protocol
https://github.com/p4zd4n/distributed-averaging-system
client java network-programming server sockets udp
Last synced: about 1 month ago
JSON representation
App to calculate the average of collected from various instances numerical data and to transfer it between devices in the local network using UDP protocol
- Host: GitHub
- URL: https://github.com/p4zd4n/distributed-averaging-system
- Owner: P4ZD4N
- Created: 2024-11-20T17:14:26.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-28T13:15:48.000Z (about 2 months ago)
- Last Synced: 2024-11-28T13:48:28.100Z (about 2 months ago)
- Topics: client, java, network-programming, server, sockets, udp
- Language: Java
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💻 Distributed Averaging System
## 👀 About
Distributed Averaging System is app that operates in two modes: master and slave. The purpose of the application is to collect numerical data from various instances of the program and calculate the average of these numbers. The application uses the UDP communication protocol to transfer data between devices in the local network.
## 📋 How the application works
### General
The application consists of, among others, a program implementing the DAS (Distributed Averaging
System) started with the command:
```bash
java DAS
```
where `````` is a number specifying the UDP port number and `````` is an integer.
The application works in two modes: master and slave. The mode selection is automatic
when the application is launched based on the current system state and the specified state
parameter. When launched, the application tries to create a UDP socket by opening a
UDP port with the number given by the `````` parameter. This operation can have two results:
- The application succeeds to open the requested port. This is where the app comes in
in **master mode**.
- The application fails to open the port because it is already occupied. In this case, the application
starts working in **slave mode**.
### Master mode
Application working in master mode remembers value passed as the `````` parameter
and then receives messages cyclically in a loop through the socket on port ``````. Next application operations depends on value of the number received in the message:
- If this value is different than ```0``` and ```-1```, the process writes this value to the console and remembers it.
- If this value is ```0```, the process:
* Calculates the average value of all non-zero numbers received from start of work, including the `````` value.
* Writes average value to the console.
* Using the socket, on which it is working, it sends a broadcast message to all computers in its local network to port number `````` (the same one, on which it works on) containing the calculated average value.
- If this value is ```-1```, the process:
* Writes this value to the console.
* Using the socket, on which it is working, it sends a broadcast message to all computers in its local network to port number `````` (the same one, on which it works on) containing ```-1``` value.
* Closes the socket and ends work.
### Slave mode
An application working in slave mode creates a UDP socket by opening a random UDP port
number (relying on the operating system in this respect) and then using
this socket, sends it to a process working on the same machine on port number
`````` message containing the value of the `````` parameter. After doing this
the process terminates.
## 🔧 Tech Stack
- Java 8
- Bash
## ▶️ Run
Clone the project
```bash
git clone [email protected]:P4ZD4N/distributed-averaging-system.git
```
Navigate to the project source directory
```bash
cd /path/to/distributed-averaging-system/src
```
Compile DAS class
```bash
javac DAS.java
```
Run app
```bash
java DAS
```
## ⚙️ Bash scripts
I created two additional bash scripts: `sender.sh` and `sniffer.sh`. They are intended for working with app from other computers in our local network (from any computer on which we do not have instance of master yet).
`sender.sh`
This script can help you with sending numbers to the master from different computer. If you know IP address of the computer, on which the master is running and port, on which it receives the numbers. Usage:
```bash
./sender.sh
```
`sniffer.sh`
Because master sends a broadcast message to all computers in its local network on the port, on which it works, we have opportunity to receive such messages on different computer. We can do it using this script. Usage:
```bash
./sniffer.sh
```
## 📺 Demo
GIF below presents compilation of app and running it in master mode on port 3000. 10 is first number, which is remembered by master.
GIF below presents running app in slave mode, because port 3000 is already occupied. 15 and 25 is sending to master and remembered.
GIF below presents running sender and sniffer scripts on different computer. Firstly (with invocation of sender) script sends 50 to master. Next, sniffer is waiting for messages broadcasted by master.
GIF below presents running app in slave mode to send 0 and -1 numbers. 0 causes the average calculated from all numbers received so far to be broadcast. -1 shuts down app.
Image below presents effect of sending 0 and -1, which was shown on previous GIF. As you can see sniffer received both messages broadcasted by master.
