apple/swift-nio-extras
1
0
Fork 0
mirror of https://github.com/apple/swift-nio-extras.git synced 2025-05-14 08:52:42 +08:00
Code Issues Packages Projects Releases Wiki Activity
swift-nio-extras/README.md
Johannes Weiss 0dbd54199d
add RequestResponseHandler (#23) 
Motivation:

Frequently, people want to terminate their pipeline with a handler that
takes in requests & a promise and on receipt of the response just
fulfill that promise.

Modifications:

- add `RequestResponseHandler`
- remove outdated of contents from README.md

Result:

more useful handlers
2019-01-29 15:30:24 +00:00

2.3 KiB
Raw Blame History

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.

The policies about breaking API changes in this repository are not as strictly followed as in the other SwiftNIO repositories. We indicate this by starting with major version 0 (0.x.y). We will try to increment the minor version number whenever there is a breaking change until we release 1.0.0 when we will start to follow the usual SemVer requirements. We recommend that users depend on .upToNextMinor as we reserve the right to introduce breaking changes with minor version increments. For patch level increments, we might only introduce new functionality.

Using NIOExtras:

dependencies: [
    .package(url: "https://github.com/apple/swift-nio-extras.git", .upToNextMinor(from: "0.1.0")),
],

Current Contents

  • QuiescingHelper: Helps to quiesce a server by notifying user code when all previously open connections have closed.
  • LineBasedFrameDecoder Splits incoming ByteBuffers on line endings.
  • FixedLengthFrameDecoder Splits incoming ByteBuffers by a fixed number of bytes.
  • LengthFieldBasedFrameDecoder Splits incoming ByteBuffers by a number of bytes specified in a fixed length header contained within the buffer.
  • LengthFieldPrepender Prepends the number of bytes to outgoing ByteBuffers as a fixed length header. Can be used in a codec pair with the LengthFieldBasedFrameDecoder.
  • RequestResponseHandler Matches a request and a promise with the corresponding response.