Skip to content

Commit 37cbb14

Browse files
authored
Merge pull request #170 from WEBcodeX1/copilot/update-readme-http-1-2
Document NLAP transition and HTTP/1.2 discontinuation in README
2 parents a5483ac + bdaef9b commit 37cbb14

File tree

1 file changed

+51
-26
lines changed

1 file changed

+51
-26
lines changed

README.md

Lines changed: 51 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<h1 align="center">🚀 HTTP/1.2 - FalconAS</h1>
2-
<p align="center"><em>Lightning-Fast, Next-Level Python / Java Application Server with HTTP/1.2 Protocol</em></p>
1+
<h1 align="center">🚀 NLAP - FalconAS</h1>
2+
<p align="center"><em>Lightning-Fast, Next-Level Python / Java Application Server with NLAP (Next Level Application Protocol)</em></p>
33

44
<div align="center">
55
<a href="https://github.com/WEBcodeX1/http-1.2/actions/workflows/github-code-scanning/codeql">
@@ -25,10 +25,15 @@
2525

2626
## :pushpin: Overview
2727

28-
**HTTP/1.2** is a revolutionary approach to web protocols, designed as a simpler, more secure,
29-
and significantly faster alternative to HTTP/2 and probably HTTP/3.
28+
**NLAP (Next Level Application Protocol)** is a revolutionary XML-based protocol designed to replace HTTP
29+
in place of modern web-application requirements.
3030

31-
We are building **HTTP/1.2** - a much more lightweight solution.
31+
**NLAP solves these problems** with a clean, XML-based transport encapsulation that natively supports:
32+
- Solid parallel response transmission in a single socket
33+
- Eliminates head-of-line blocking: time-consuming responses do not block follow-ups
34+
- Structured data with XML schemas
35+
- Multiple protocol subtypes (NLAFP for files, NLAMP for metadata)
36+
- Simple, extensible architecture
3237

3338
-**Kernel Mutex-Less**: Built with on-chip atomic user space locks
3439
-**Lightning-Fast Performance**: Optimized for modern hardware with epoll-based architecture
@@ -43,7 +48,7 @@ We are building **HTTP/1.2** - a much more lightweight solution.
4348

4449
1. [Quick Start](#racehorse-quick-start)
4550
2. [Features](#star2-features)
46-
3. [Why HTTP/1.2?](#mega-why-http12)
51+
3. [Why NLAP Instead of HTTP/1.2?](#mega-why-nlap-instead-of-http12)
4752
4. [Build & Installation](#hammer_and_wrench-build--installation)
4853
5. [Testing](#test_tube-testing)
4954
6. [Technical Architecture](#gear-technical-architecture)
@@ -57,7 +62,7 @@ We are building **HTTP/1.2** - a much more lightweight solution.
5762

5863
## :racehorse: Quick Start
5964

60-
Get HTTP/1.2 FalconAS running in minutes:
65+
Get FalconAS (using HTTP/1.1 or NLAP) running in minutes:
6166

6267
```bash
6368
# clone repository
@@ -84,8 +89,8 @@ sudo systemctl start falcon-as
8489
```
8590

8691
The server will be available with test applications at:
87-
- `http://testapp1.local/`
88-
- `http://testapp2.local/`
92+
- `http://testapp1.local/` (HTTP/1.1 compatibility mode)
93+
- `http://testapp2.local/` (HTTP/1.1 compatibility mode)
8994

9095
For detailed installation instructions, see [BUILD.md](BUILD.md).
9196

@@ -96,16 +101,18 @@ For detailed installation instructions, see [BUILD.md](BUILD.md).
96101
### Core Advantages
97102
- **🚀 Lightning-Fast**: Epoll-based architecture for maximum performance
98103
- **🔒 Secure by Design**: Interpreters run non-threaded / unix process isolated
99-
- **⚡ Zero Bloat**: Eliminates HTTP/2's excessive complexity
100-
- **🎯 SPA-Optimized**: Perfect for modern Single Page Applications real time demands
104+
- **⚡ Zero Bloat**: Clean XML-based protocol without HTTP's legacy complexity
105+
- **🎯 SPA-Optimized**: Perfect for modern Single Page Applications real-time demands
101106
- **🐍 Python-Powered**: Embedded Python interpreter / scripting integration
102107
- **☕ Java-Powered**: Embedded Java JNI / scripting integration
103108

104-
### Protocol Innovations
105-
- **Fixed HTTP/1.1 Pipelining**: Resolves misordered request/reply pairs with UUID headers
106-
- **Permanent Keep-Alive**: Single socket per client for optimal TCP/IP utilization
107-
- **Request UUID System**: Eliminates response ordering requirements
108-
- **Simplified Architecture**: Text-based protocol maintaining HTTP/1.1 simplicity
109+
### NLAP Protocol Innovations
110+
- **XML-Based Transport**: Clean, structured request/response format
111+
- **Native UUID System**: Built-in request/response matching
112+
- **Multiple Subtypes**: NLAFP for file transfer, NLAMP for application metadata
113+
- **Extensible Architecture**: XML schemas enable easy protocol evolution
114+
- **Partial File Transfer**: Efficient handling of large files with chunked transfer
115+
- **Request/Response Signing**: Built-in cryptographic signing support
109116

110117
### Technical Features
111118
- **Static Content Server**: High-performance file serving with sendfile()
@@ -117,7 +124,15 @@ For detailed installation instructions, see [BUILD.md](BUILD.md).
117124

118125
---
119126

120-
## :mega: Why HTTP/1.2?
127+
## :mega: Why NLAP Instead of HTTP/1.2?
128+
129+
### The Problem with HTTP/1.2
130+
131+
**HTTP/1.2 is not being pursued** - The original plan to extend HTTP/1.1 with UUID headers faces insurmountable challenges:
132+
133+
- **Ancient Text-Based Protocol Design**: HTTP's line-based parsing is incompatible with efficient UUID integration
134+
- **Client Library Overhead**: Client processing must be re-implemented for a dead protocol, this means unnecessary effort,
135+
better implement intop modern NLAP design
121136

122137
### The Problem with HTTP/2 & HTTP/3
123138

@@ -128,14 +143,20 @@ For detailed installation instructions, see [BUILD.md](BUILD.md).
128143
- TLS/SSL handling unnecessarily embedded in protocol
129144

130145
**HTTP/3 UDP Issues:**
131-
- Works only for precalculated CDN data
132-
- Creates new complexity without solving core issues
146+
- Solves core issues but moves unneccessary (already worldwide approved and adopted) complexity
147+
from TCP into UDP (application) layer
148+
149+
### Our Solution: NLAP (Next Level Application Protocol)
133150

134-
### Our Solution: HTTP/1.2
151+
NLAP replaces HTTP's legacy concepts with a clean, modern XML-based and application-centric (not document-centric) protocol.
135152

136-
HTTP/1.2 **fixes** HTTP/1.1's single major flaw (broken pipelining) while **avoiding** HTTP/2's complexity:
153+
> **🎯 Key Innovation**: XML transport encapsulation, structured data, reliable concurrent-response transmission and extensibility that HTTP's ancient text format cannot match.
137154
138-
> **🎯 Key Innovation**: Adding a simple `Request-UUID` header eliminates response ordering issues, making HTTP/2's complex Layer-7 multiplexing unnecessary.
155+
**NLAP Protocol Specifications:**
156+
- **XML-Based**: Structured, parseable, extensible format
157+
- **Built-in UUID**: Native request/response correlation
158+
- **Multiple Subtypes**: NLAFP for file protocol, NLAMP for metadata protocol
159+
- **First Specs Available**: See `/specs/xml/` for NLAFP and NLAMP documentation
139160

140161
---
141162

@@ -258,7 +279,9 @@ See [test documentation](/test/README.md) for detailed testing procedures.
258279
- **Detailed Analysis**: [Der IT Prüfer](http://der-it-pruefer.de)
259280

260281
### Protocol Specifications
261-
- **WAP/XML Specs**: [WAP-AS-XML-SPECS.md](WAP-AS-XML-SPECS.md)
282+
- **NLAP XML Specs**: See [/specs/xml/](/specs/xml/) for detailed protocol documentation
283+
- [NLAFP (Next Level Application File Protocol)](/specs/xml/NLAFP-XML-SPECS.md)
284+
- [NLAMP (Next Level Application Metadata Protocol)](/specs/xml/NLAMP-XML-SPECS.md)
262285
- **Internal Libraries**: [lib/README.md](lib/README.md)
263286

264287
---
@@ -299,13 +322,15 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
299322
### Short-term Goals
300323
- [x] **HTTP/1.1 Compatibility**: Minimal SPA related features
301324
- [x] **x0 Framework Integration**: Seamless SPA framework compatibility
302-
- [ ] **HTTP/1.2 Protocol**: Implementation including client library
303-
- [ ] **Performance Benchmarks**: Comprehensive HTTP/1.1, HTTP/2, HTTP/3 comparisons
325+
- [ ] **NLAP Protocol Implementation**: Complete NLAFP and NLAMP implementation
326+
- [ ] **NLAP Client Library**: Reference implementation for clients
327+
- [ ] **Performance Benchmarks**: Comprehensive HTTP/1.1, HTTP/2, HTTP/3, and NLAP comparisons
304328

305329
### Long-term Vision
306-
- [ ] **Protocol Standardization**: Submit HTTP/1.2 as official RFC
330+
- [ ] **Protocol Standardization**: Submit NLAP as official RFC
307331
- [ ] **Enterprise Features**: Advanced monitoring, analytics, management
308332
- [ ] **Proxy Server Component**: Complete the load balancing/reverse proxy module
333+
- [ ] **NLAP Browser Support**: Native NLAP support in modern browsers
309334

310335
See [GitHub Milestones](https://github.com/WEBcodeX1/http-1.2/milestones) for detailed roadmap.
311336

0 commit comments

Comments
 (0)