Kitura-NIO is a SwiftNIO based networking library for Kitura. Kitura-NIO adopts the same API as KituraNet, making the transition from KituraNet to Kitura-NIO seamless. While Kitura-NIO shares some code with Kitura-Net, the core comprising of HTTPServer, ClientRequest/ClientResponse and TLS support have been implemented using SwiftNIO. Kitura-NIO uses NIOOpenSSL for TLS support.
We expect most of our users to require higher level concepts such as routing, templates and middleware, these are not provided in Kitura-NIO, if you want to use those facilities you should be coding at the Kitura level, for this please see the Kitura project. Kitura-NIO, like Kitura-net, underpins Kitura which offers a higher abstraction level to users.
Kitura-NIO works with Swift 4.2. It is also being tested with the development binaries for Swift 5.
- Port Listening
- HTTP Server support (request and response)
With Kitura 2.5 and future releases, to run on top of Kitura-NIO (instead of Kitura-Net) all you need to do is set an environment variable called
KITURA_NIO before building your Kitura appilication:
export KITURA_NIO=1 && swift build
If you have already built your Kitura application using Kitura-Net and want to switch to using
KITURA_NIO, you need to update the package before building:
export KITURA_NIO=1 && swift package update && swift build
Using the environment variable we make sure that only one out of Kitura-NIO and Kitura-Net is linked into the final binary.
Please note that though Kitura-NIO has its own GitHub repository, the package name is
KituraNet. This is because the Kitura-NIO and Kitura-Net are expected to provide identical APIs, and it make sense if they share the package name too.
Visit www.kitura.io for reference documentation.
Contributing to Kitura-NIO
We'd be more than happy to receive bug reports, enhancement requests and pull requests!
- Clone this repository.
$ git clone https://github.com/IBM-Swift/Kitura-NIO && cd Kitura-NIO
- Build and run tests.
$ swift test
You may also want to run the tests in parallel:
$ swift test --parallel
In some Linux environments, a low open file limit could cause test failures. See this.
We'd really love to hear feedback from you.
This library is licensed under Apache 2.0. Full license text is available in LICENSE.
Help us keep the lights on
1.0.12 - Jan 18, 2019
Minor performance improvements - #146 and #143
1.0.8 - Jan 3, 2019
In this release we drop the "vX.Y.Z" format for the release name and conform to other Kitura repos that adopt a "X.Y.Z" format.
- A few performance improvements (#117, #118 and #120)
- We now conform to the syntax rules enforced by
swiftlint(#121, #122, #123, #124, #125)
- Jazzy doc generation and Codecov support (#133 and #134)
- The tests may be run with ephemeral ports which make
swift test --parallelpossible (#129 and #130)
- A longstanding flaky test fixed (#131)
Thanks to @nethraravindran for her work on swiftlint, jazzy doc generation and codecov.
v1.0.7 - Dec 18, 2018
- Swift 5 support (#116)
- Performance improvement for calculating utf8-encoded content length (#114)
v1.0.6 - Nov 22, 2018
- Fixes for two data races -
HTTPServerRequest.keepAliveState(#99) and one in
- Skip storing an
- Tests: move libressl installation to
- Performance enhancements: reimplementing
HTTServerRequest.url(#112), better headers translation(#113) and
- Other minor code readability enhancements
v1.0.5 - Sep 17, 2018
- Remove all but one fatalError invocations from Kitura-NIO (#90)
- A bug fix related to the default HTTP version, we now default to 1.1 if the request has no version info (#88)
- Some refactoring and code cleanup (#88, #89)