Skip to content

Commit 853662d

Browse files
committed
add doc
1 parent 3f3a437 commit 853662d

File tree

14 files changed

+5823
-123
lines changed

14 files changed

+5823
-123
lines changed

content/docs/modules/crypto/base64.md

Lines changed: 654 additions & 0 deletions
Large diffs are not rendered by default.

content/docs/modules/crypto/digest.md

Lines changed: 658 additions & 0 deletions
Large diffs are not rendered by default.

content/docs/modules/network/_index.md

Lines changed: 88 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,44 @@ The **Network** module provides comprehensive networking capabilities for buildi
1010

1111
---
1212

13-
### Acceptor
13+
### MAC Address
1414

15-
Server socket abstraction for accepting incoming connections.
15+
MAC (Media Access Control) address handling.
1616

1717
**Features:**
1818

19-
* Template-based for different protocols (Tcp, Tls, UnixStream)
20-
* Non-blocking accept operations
21-
* Reactor integration
19+
* 48-bit MAC address representation
20+
* Parsing and formatting
21+
* Address comparison
2222

2323
---
2424

25-
### ARP
25+
### IP Address
2626

27-
Address Resolution Protocol implementation.
27+
IP address abstraction (IPv4/IPv6).
2828

2929
**Features:**
3030

31-
* ARP request/reply handling
32-
* MAC address resolution
33-
* Network layer utilities
31+
* IPv4 and IPv6 support
32+
* Address parsing and formatting
33+
* Network/broadcast address calculation
3434

3535
---
3636

37-
### ChunkStream
37+
### Protocol
3838

39-
HTTP chunked transfer encoding support.
39+
Protocol definitions and socket types.
4040

41-
**Features:**
41+
**Protocol Types:**
4242

43-
* Chunked encoding/decoding
44-
* Stream-based interface
45-
* HTTP/1.1 compliance
43+
* **Tcp** - TCP stream sockets
44+
* **Udp** - UDP datagram sockets
45+
* **Tls** - TLS/SSL encrypted sockets
46+
* **UnixStream** - Unix domain stream sockets
47+
* **UnixDgram** - Unix domain datagram sockets
48+
* **Raw** - Raw IP sockets
49+
* **Icmp** - ICMP sockets
50+
* **Netlink** - Netlink sockets
4651

4752
---
4853

@@ -58,137 +63,132 @@ Network endpoint abstraction (IP address + port).
5863

5964
---
6065

61-
### HttpClient
66+
### Socket
6267

63-
HTTP/HTTPS client implementation.
68+
Low-level socket abstraction.
6469

6570
**Features:**
6671

67-
* GET, POST, PUT, DELETE, HEAD, PATCH methods
68-
* TLS/SSL support
69-
* Keep-alive connections
72+
* Template-based for different protocols
73+
* Non-blocking I/O
74+
* Socket options (SO_REUSEADDR, SO_KEEPALIVE, etc.)
7075

7176
---
7277

73-
### HttpMessage
74-
75-
HTTP request and response message handling.
76-
77-
**Classes:**
78+
### Socket Stream
7879

79-
* **HttpRequest** - HTTP request message
80-
* **HttpResponse** - HTTP response message
80+
Stream interface for sockets.
8181

8282
**Features:**
8383

84-
* Header management
85-
* Body handling
86-
* Status codes and methods
84+
* std::iostream integration
85+
* Buffered I/O
86+
* Stream operators (<<, >>)
8787

8888
---
8989

90-
### HttpServer
90+
### Acceptor
9191

92-
HTTP/HTTPS server implementation.
92+
Server socket abstraction for accepting incoming connections.
9393

9494
**Features:**
9595

96-
* Request handling callbacks
97-
* Multi-threaded support
98-
* TLS/SSL support
96+
* Template-based for different protocols (Tcp, Tls, UnixStream)
97+
* Non-blocking accept operations
98+
* Reactor integration
9999

100100
---
101101

102-
### Interface
102+
### ARP
103103

104-
Network interface information and management.
104+
Address Resolution Protocol implementation.
105105

106106
**Features:**
107107

108-
* Interface enumeration
109-
* IP address assignment
110-
* MTU and flags
108+
* ARP request/reply handling
109+
* MAC address resolution
110+
* Network layer utilities
111111

112112
---
113113

114-
### InterfaceManager
114+
### DNS Resolver
115115

116-
System network interface management.
116+
DNS resolution and hostname lookup.
117117

118118
**Features:**
119119

120-
* Interface discovery
121-
* Address family filtering
122-
* Interface status monitoring
120+
* Hostname to IP resolution
121+
* Service name resolution
122+
* IPv4/IPv6 support
123123

124124
---
125125

126-
### IpAddress
126+
### HTTP Message
127127

128-
IP address abstraction (IPv4/IPv6).
128+
HTTP request and response message handling.
129+
130+
**Classes:**
131+
132+
* **HttpRequest** - HTTP request message
133+
* **HttpResponse** - HTTP response message
129134

130135
**Features:**
131136

132-
* IPv4 and IPv6 support
133-
* Address parsing and formatting
134-
* Network/broadcast address calculation
137+
* Header management
138+
* Body handling
139+
* Status codes and methods
135140

136141
---
137142

138-
### MacAddress
143+
### HTTP/HTTPS Client
139144

140-
MAC (Media Access Control) address handling.
145+
HTTP/HTTPS client implementation.
141146

142147
**Features:**
143148

144-
* 48-bit MAC address representation
145-
* Parsing and formatting
146-
* Address comparison
149+
* GET, POST, PUT, DELETE, HEAD, PATCH methods
150+
* TLS/SSL support
151+
* Keep-alive connections
147152

148153
---
149154

150-
### MailMessage
155+
### HTTP Chunk Stream
151156

152-
Email message construction for SMTP.
157+
HTTP chunked transfer encoding support.
153158

154159
**Features:**
155160

156-
* MIME message building
157-
* Header management
158-
* Attachment support
161+
* Chunked encoding/decoding
162+
* Stream-based interface
163+
* HTTP/1.1 compliance
159164

160165
---
161166

162-
### Protocol
167+
### HTTP/HTTPS Server
163168

164-
Protocol definitions and socket types.
169+
HTTP/HTTPS server implementation.
165170

166-
**Protocol Types:**
171+
**Features:**
167172

168-
* **Tcp** - TCP stream sockets
169-
* **Udp** - UDP datagram sockets
170-
* **Tls** - TLS/SSL encrypted sockets
171-
* **UnixStream** - Unix domain stream sockets
172-
* **UnixDgram** - Unix domain datagram sockets
173-
* **Raw** - Raw IP sockets
174-
* **Icmp** - ICMP sockets
175-
* **Netlink** - Netlink sockets
173+
* Request handling callbacks
174+
* Multi-threaded support
175+
* TLS/SSL support
176176

177177
---
178178

179-
### Resolver
179+
### Mail Message
180180

181-
DNS resolution and hostname lookup.
181+
Email message construction for SMTP.
182182

183183
**Features:**
184184

185-
* Hostname to IP resolution
186-
* Service name resolution
187-
* IPv4/IPv6 support
185+
* MIME message building
186+
* Header management
187+
* Attachment support
188188

189189
---
190190

191-
### SmtpClient
191+
### SMTP/SMTPS Client
192192

193193
SMTP/SMTPS email client.
194194

@@ -200,27 +200,27 @@ SMTP/SMTPS email client.
200200

201201
---
202202

203-
### Socket
203+
### Interface
204204

205-
Low-level socket abstraction.
205+
Network interface information and management.
206206

207207
**Features:**
208208

209-
* Template-based for different protocols
210-
* Non-blocking I/O
211-
* Socket options (SO_REUSEADDR, SO_KEEPALIVE, etc.)
209+
* Interface enumeration
210+
* IP address assignment
211+
* MTU and flags
212212

213213
---
214214

215-
### SocketStream
215+
### Interface Manager
216216

217-
Stream interface for sockets.
217+
System network interface management.
218218

219219
**Features:**
220220

221-
* std::iostream integration
222-
* Buffered I/O
223-
* Stream operators (<<, >>)
221+
* Interface discovery
222+
* Address family filtering
223+
* Interface status monitoring
224224

225225
---
226226

0 commit comments

Comments
 (0)