Skip to content

Commit 449b703

Browse files
author
mrabine
committed
2 parents 0b7f085 + 671822c commit 449b703

File tree

16 files changed

+1420
-172
lines changed

16 files changed

+1420
-172
lines changed

content/docs/modules/core/_index.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,6 @@ High-precision timers using timerfd with reactor integration:
166166

167167
## 🗂️ Utilities
168168

169-
### Cache
170-
171-
File content caching using memory-mapped files:
172-
173-
- Memory-mapped file caching (mmap)
174-
- Automatic modification time tracking
175-
- Thread-safe operations
176-
177169
### File System
178170

179171
File system utilities and operations:
@@ -182,18 +174,6 @@ File system utilities and operations:
182174
- Path manipulation
183175
- File status queries
184176

185-
### View
186-
187-
Non-owning views for efficient data access without copies:
188-
189-
- **StringView** - Lightweight string view with seek support
190-
- **StreamView** - Stream buffer view (seekable/non-seekable)
191-
- **BufferingView** - Adapter with snapshot/consume operations
192-
193-
### Stream Buffer
194-
195-
Custom stream buffer implementations for specialized I/O.
196-
197177
### Variant
198178

199179
Type-safe union implementation supporting multiple types:

content/docs/modules/core/acceptor.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Two acceptor types are available:
2525

2626
## BasicStreamAcceptor
2727

28-
The base acceptor class for connection‑oriented protocols.
28+
The base acceptor class for connection‑oriented protocols such as TCP and Unix stream.
2929

3030
### Creating a TCP server
3131

@@ -507,10 +507,6 @@ The `IPV6_V6ONLY` option is automatically disabled, allowing IPv4 clients to con
507507

508508
| Protocol | Acceptor Type | Use Case |
509509
| ------------- | --------------------- | ----------------------- |
510-
| Tcp | BasicStreamAcceptor | HTTP, custom protocols |
511510
| UnixStream | BasicStreamAcceptor | Local IPC |
511+
| Tcp | BasicStreamAcceptor | HTTP, custom protocols |
512512
| Tls | BasicTlsAcceptor | Secure TCP |
513-
| Http | BasicStreamAcceptor | Web servers |
514-
| Https | BasicTlsAcceptor | Secure web servers |
515-
| Smtp | BasicTlsAcceptor | Email servers (STARTTLS)|
516-
| Smtps | BasicTlsAcceptor | Secure email servers |

content/docs/modules/core/endpoint.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -67,22 +67,6 @@ Tcp::Endpoint endpoint1(ip, 8080);
6767
Tcp::Endpoint endpoint2("10.0.0.1", 8080);
6868
```
6969
70-
### From URL
71-
72-
```cpp
73-
// Hostname resolution happens automatically
74-
Tcp::Endpoint web("https://example.com:8443");
75-
76-
std::cout << web.ip() << "\n"; // Resolved IP
77-
std::cout << web.port() << "\n"; // 8443
78-
std::cout << web.hostname() << "\n"; // example.com
79-
```
80-
81-
URL parsing extracts:
82-
- Scheme (determines default port)
83-
- Hostname (resolved to IP)
84-
- Port (explicit or default)
85-
8670
### From protocol and port
8771
8872
```cpp
@@ -302,10 +286,10 @@ const struct sockaddr* caddr = endpoint.addr();
302286
303287
| Endpoint Type | Address Type | Additional Data |
304288
| -------------------- | ---------------- | ---------------------- |
305-
| BasicInternetEndpoint| IP + Port | Hostname, device |
306289
| BasicUnixEndpoint | Filesystem path | - |
307290
| BasicNetlinkEndpoint | PID + Groups | Protocol type |
308291
| BasicLinkLayerEndpoint| Interface | - |
292+
| BasicInternetEndpoint| IP + Port | Hostname, device |
309293
310294
All endpoints provide:
311295
- `protocol()` — get associated protocol

content/docs/modules/core/socket.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ socket.setCaFile("/etc/ssl/certs/ca-bundle.crt");
304304
socket.setCaPath("/etc/ssl/certs/");
305305
```
306306

307-
⚠️ By default, peer verification is **disabled**. Always enable it for production clients.
307+
⚠️ By default, peer verification is **disabled**.
308308

309309
### Setting client certificate
310310

@@ -423,7 +423,7 @@ int proto = socket.protocol(); // IPPROTO_TCP, IPPROTO_UDP
423423
### MTU discovery
424424

425425
```cpp
426-
// Get path MTU (datagram sockets)
426+
// Get path MTU
427427
int mtu = socket.mtu();
428428
```
429429

content/docs/modules/core/socketstream.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -656,10 +656,6 @@ bool readWithTimeout(Tcp::Stream& stream, std::string& line, int ms) {
656656
657657
| Protocol | Stream Type | Use Case |
658658
| ---------- | ----------------- | --------------------------- |
659-
| Tcp | BasicSocketStream | HTTP, custom text protocols |
660659
| UnixStream | BasicSocketStream | Local IPC |
660+
| Tcp | BasicSocketStream | HTTP, custom text protocols |
661661
| Tls | BasicTlsStream | Secure TCP |
662-
| Http | BasicSocketStream | Web clients |
663-
| Https | BasicTlsStream | Secure web clients |
664-
| Smtp | BasicTlsStream | Email clients (STARTTLS) |
665-
| Smtps | BasicTlsStream | Secure email clients |

0 commit comments

Comments
 (0)