mirror of
https://github.com/apple/swift-nio-extras.git
synced 2025-05-14 17:02:43 +08:00
96e8335180
Motivation: Especially with TLS but also without, in real production environments it can be handy to be able to write pcap files from NIO directly. Modifications: add a ChannelHandler that can write a PCAP trace from what's going on in the ChannelPipeline. Result: easier debugging in production
NIOExtras
NIOExtras is a good place for code that is related to NIO but not core. It can also be used to incubate APIs for tasks that are possible with core-NIO but are cumbersome today.
What makes a good contribution to NIOExtras?
- a protocol encoder/decoder pair (also called "codec") that is often used but is small enough so it doesn't need its own repository
- a helper to achieve a task that is harder-than-necessary to achieve with core-NIO
Code Quality / Stability
All code will go through code review like in the other repositories related to the SwiftNIO project.
swift-nio-extras part of the SwiftNIO 2 family of repositories and depends on the following:
swift-nio, version 2.0.0 or better.- Swift 5.0.
zliband its development headers installed on the system. But don't worry, you'll findzlibon pretty much any UNIX system that can compile any sort of code.
To depend on swift-nio-extras, put the following in the dependencies of your Package.swift:
.package(url: "https://github.com/apple/swift-nio-extras.git", from: "1.0.0"),
Support for older Swift versions
On the nio-extras-0.1 branch, you can find the swift-nio-extras version for the SwiftNIO 1 family. It requires Swift 4.1 or better.
Current Contents
QuiescingHelper: Helps to quiesce a server by notifying user code when all previously open connections have closed.LineBasedFrameDecoderSplits incomingByteBuffers on line endings.FixedLengthFrameDecoderSplits incomingByteBuffers by a fixed number of bytes.LengthFieldBasedFrameDecoderSplits incomingByteBuffers by a number of bytes specified in a fixed length header contained within the buffer.LengthFieldPrependerPrepends the number of bytes to outgoingByteBuffers as a fixed length header. Can be used in a codec pair with theLengthFieldBasedFrameDecoder.RequestResponseHandlerMatches a request and a promise with the corresponding response.HTTPResponseCompressorCompresses the body of every HTTP/1 response message.