aboutsummaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorGravatar Aoang <aoang@x2oe.com> 2022-08-14 17:31:57 +0800
committerGravatar GitHub <noreply@github.com> 2022-08-14 11:31:57 +0200
commitea6052464e7221956dedf9b9a523f8f9892c3d3b (patch)
tree089ef1b083c7d9edc7d54bc2485b1a564a2cc368 /doc.go
parentImprove Client timeout (#1346) (diff)
downloadfasthttp-ea6052464e7221956dedf9b9a523f8f9892c3d3b.tar.gz
fasthttp-ea6052464e7221956dedf9b9a523f8f9892c3d3b.tar.bz2
fasthttp-ea6052464e7221956dedf9b9a523f8f9892c3d3b.zip
Add Go 1.19 Support (#1355)v1.39.0
* Update Go Version to Go1.19.x And add cache * Fix CI Line endings * Update test CI Go Version to Go1.19.x And add cache * Update Gosec Security Scanner CI to securego/gosec@v2.12.0 * Format comment Go 1.19 adds support for links, lists, and clearer headings in doc comments. As part of this change, gofmt now reformats doc comments to make their rendered meaning clearer. See “Go Doc Comments” for syntax details and descriptions of common mistakes now highlighted by gofmt. As another part of this change, the new package go/doc/comment provides parsing and reformatting of doc comments as well as support for rendering them to HTML, Markdown, and text. ref: https://tip.golang.org/doc/go1.19 ref: https://tip.golang.org/doc/comment * Fix doc structure
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go78
1 files changed, 48 insertions, 30 deletions
diff --git a/doc.go b/doc.go
index efcd4a0..f2bf58d 100644
--- a/doc.go
+++ b/doc.go
@@ -3,35 +3,53 @@ Package fasthttp provides fast HTTP server and client API.
Fasthttp provides the following features:
- * Optimized for speed. Easily handles more than 100K qps and more than 1M
- concurrent keep-alive connections on modern hardware.
- * Optimized for low memory usage.
- * Easy 'Connection: Upgrade' support via RequestCtx.Hijack.
- * Server provides the following anti-DoS limits:
-
- * The number of concurrent connections.
- * The number of concurrent connections per client IP.
- * The number of requests per connection.
- * Request read timeout.
- * Response write timeout.
- * Maximum request header size.
- * Maximum request body size.
- * Maximum request execution time.
- * Maximum keep-alive connection lifetime.
- * Early filtering out non-GET requests.
-
- * A lot of additional useful info is exposed to request handler:
-
- * Server and client address.
- * Per-request logger.
- * Unique request id.
- * Request start time.
- * Connection start time.
- * Request sequence number for the current connection.
-
- * Client supports automatic retry on idempotent requests' failure.
- * Fasthttp API is designed with the ability to extend existing client
- and server implementations or to write custom client and server
- implementations from scratch.
+ 1. Optimized for speed. Easily handles more than 100K qps and more than 1M
+ concurrent keep-alive connections on modern hardware.
+
+ 2. Optimized for low memory usage.
+
+ 3. Easy 'Connection: Upgrade' support via RequestCtx.Hijack.
+
+ 4. Server provides the following anti-DoS limits:
+
+ - The number of concurrent connections.
+
+ - The number of concurrent connections per client IP.
+
+ - The number of requests per connection.
+
+ - Request read timeout.
+
+ - Response write timeout.
+
+ - Maximum request header size.
+
+ - Maximum request body size.
+
+ - Maximum request execution time.
+
+ - Maximum keep-alive connection lifetime.
+
+ - Early filtering out non-GET requests.
+
+ 5. A lot of additional useful info is exposed to request handler:
+
+ - Server and client address.
+
+ - Per-request logger.
+
+ - Unique request id.
+
+ - Request start time.
+
+ - Connection start time.
+
+ - Request sequence number for the current connection.
+
+ 6. Client supports automatic retry on idempotent requests' failure.
+
+ 7. Fasthttp API is designed with the ability to extend existing client
+ and server implementations or to write custom client and server
+ implementations from scratch.
*/
package fasthttp