https://github.com/prempreetbrar/tcpwebserver
A TCP server that serves files over the Internet in response to HTTP requests.
https://github.com/prempreetbrar/tcpwebserver
concurrency demultiplexing http-get http-server java multithreading network-programming non-persistent server-side socket-programming tcp tcp-server
Last synced: about 2 months ago
JSON representation
A TCP server that serves files over the Internet in response to HTTP requests.
- Host: GitHub
- URL: https://github.com/prempreetbrar/tcpwebserver
- Owner: prempreetbrar
- Created: 2024-03-16T04:24:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T17:08:19.000Z (about 1 year ago)
- Last Synced: 2025-02-14T17:15:16.379Z (4 months ago)
- Topics: concurrency, demultiplexing, http-get, http-server, java, multithreading, network-programming, non-persistent, server-side, socket-programming, tcp, tcp-server
- Language: Java
- Homepage:
- Size: 26.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TCP Web Server
A program that serves web objects from an existing directory to HTTP clients over the Internet using TCP. Watch
a GIF of me interacting with it below!
## Features
- Supports HTTP `GET` requests.
- Operates in non-persistent HTTP mode; once the object is served, the server closes the underlying TCP connection.
- Handles multiple connections simultaneously using multi-threading; spawns a new thread and creates a new `Socket` for _each_
incoming TCP connection request (unlike UDP, where a single socket is used for all incoming requests and all messages are demultiplexed
to the _same_ socket). See the following image:
In the above image, you see a service process `P1` open three different `Socket`s for three different connecting clients; every client's segments are demultiplexed to a different `Socket` at `P1`.
- To prevent non-responsive clients from hogging server resources, if the server does not receive an HTTP message from the
client after the initial 3-way handshake, the server closes the connection and sends an error message with status code `408`. Note that
this only occurs if the client is connecting using `telnet` or certain other application layer protocols. With something like a browser, the
handshake is automatically (ie. _implicitly_) followed by an HTTP request.
- After server is shutdown, waits reasonable amount of time for current requests to be serviced before terminating.
- If the server can recover from exceptions (ie. the exception only affected a worker thread), then the server continues with normal execution. Otherwise,
it terminates.
## Usage/Limitations
- The root directory of the web server, where the objects are located, is specified as a command line input parameter. If the object path in
the `GET` request is `/object-path`, then the file containing the object is located on the absolute path `server-root/object-path` in the file
system, where `server-root` is the root directory of the web server.
- `-p ` specifies the server's port; default is `2025`
- `-t ` specifies the time after which the server closes the TCP connection in **milli-seconds**; default is `0` (which means infinity,
ie. idle connections are not closed)
- `-r ` is the root directory of the web server (where all its HTTP objects are located); default is the current directory (directory in which program
is ran)
- `quit` is typed in the system terminal to shut the server down.
- Sends responses with HTTP version `HTTP/1.1`; only returns responses with the following status codes/phrases:
```
200 OK
400 Bad Request
404 Not Found
408 Request Timeout
```
- Assumes all header lines in the HTTP request are formatted correctly; only an error in the HTTP request line can trigger a `400 Bad Request` error. A
properly formatted request line consists of three _mandatory_ parts which are separated by one or more spaces, as follows: `GET /object-path HTTP/1.1`.
The command `GET` and protocol `HTTP/1.1` are fixed, while the `object-path` is optional. If no `object-path` is provided, _ie._ the request only specifies "/",
then `index.html` is assumed by default.
## If you want to start up the project on your local machine:
1. Download the code as a ZIP:
2. Unzip the code:
3. Open the folder in an IDE, such as VSCode:
4. Start the server by compiling all files and then running `ServerDriver.java`, as follows:
```
javac *.java
java ServerDriver -p -t -r
```
5. Send a request to the server using `telnet`, a web browser, or any other application layer protocol:
