mirror of
https://github.com/apple/swift-nio-extras.git
synced 2025-05-14 17:02:43 +08:00
dabef818d3
Motivation: An index page ties all the other documentation together Modifications: Add index pages for the library targets. Correct a few minor errors in the main docs. Result: A more joined up documentation experience.
28 lines
800 B
Markdown
28 lines
800 B
Markdown
# ``NIOHTTPCompression``
|
|
|
|
Automatic compression and decompression of HTTP data.
|
|
|
|
## Overview
|
|
|
|
Channel handlers to support automatic compression and decompression of HTTP data. Add the handlers to your pipeline to support the features you need.
|
|
|
|
`Content-Encoding`, `Content-Length`, and `accept-encoding` HTTP headers are set and respected where appropriate.
|
|
|
|
Be aware that this works best if there is sufficient data written between flushes. This also performs compute on the event loop thread which could impact performance.
|
|
|
|
## Topics
|
|
|
|
### Client Channel Handlers
|
|
|
|
- ``NIOHTTPRequestCompressor``
|
|
- ``NIOHTTPResponseDecompressor``
|
|
|
|
### Server Channel Handlers
|
|
- ``NIOHTTPRequestDecompressor``
|
|
- ``HTTPResponseCompressor``
|
|
|
|
### Compression Methods
|
|
|
|
- ``NIOCompression``
|
|
- ``NIOHTTPDecompression``
|