SwiftNIO is fundamentally a low-level tool for building high-performance networking applications in Swift. SemVer and SwiftNIO's Public API guarantees should result in a working program without having to worry about testing every single version for compatibility. In SwiftPM that can be easily done specifying for example from: '2.0.0' meaning that you support SwiftNIO in every version starting from 2.0.0 up to (excluding) 3.0.0. What this means for you is that you should depend on SwiftNIO with a version range that covers everything from the minimum SwiftNIO version you require up to the next major version. SwiftNIO follows SemVer 2.0.0 with a separate document declaring SwiftNIO's Public API. macOS 10.9+, iOS 7+ (macOS 10.14+, iOS 12+, tvOS 12+ or watchOS 6+ with swift-nio-transport-services).Currently, it is developed and tested on macOS and Linux, and is known to support the following operating system versions: SwiftNIO aims to support all of the platforms where Swift is supported. The latest released SwiftNIO 1 version supports Swift 4.0, 4.1, 4.2, and 5.0. If you have a SwiftNIO 1 application or library that you would like to migrate to SwiftNIO 2, please check out the migration guide we prepared for you. No new features will be added to this version but PRs which fix bugs or security vulnerabilities will be accepted until the end of May 2022. The Core NIO team does not actively work on this version. SwiftNIO 1 is considered end of life - it is strongly recommended that you move to a newer version. The latest released SwiftNIO 2 version supports Swift 5.2+. This is the current version of SwiftNIO and will be supported for the foreseeable future. ProtocolĪlso offers a low-level API SSWG community project The implementations listed below do still do all of their I/O in SwiftNIO and integrate really well with the SwiftNIO ecosystem. High-level implementations are usually libraries that come with an API that doesn't expose SwiftNIO's ChannelPipeline and can therefore be used with very little (or no) SwiftNIO-specific knowledge. Often, low-level protocol implementations will then be wrapped in high-level libraries with a nicer, more user-friendly API. Low-level protocol implementations are often a collection of ChannelHandlers that implement a protocol but still require the user to have a good understanding of SwiftNIO. All of the libraries listed below do all of their I/O in a non-blocking fashion using SwiftNIO. This is a non-exhaustive list of protocols that are either part of the SwiftNIO project or are accepted into the SSWG's incubation process. This provides a number of helpers for testing projects that use SwiftNIO.īelow you can find a list of a few protocol implementations that are done with SwiftNIO. This provides a low-level WebSocket protocol implementation. This provides a low-level HTTP/1.1 protocol implementation. Note that this doesn't provide TLS itself: please investigate swift-nio-ssl and swift-nio-transport-services for concrete implementations. This provides a few common abstraction types for working with multiple TLS implementations. If you are working with Foundation data types such as Data, you should import this. This extends a number of NIO types for better interoperation with Foundation data types. This provides a few low-level concurrency primitives that are used by NIO implementations, such as locks and atomics. These are most often used for testing, but can also be used to drive protocol implementations in a way that is decoupled from networking altogether. This provides EmbeddedChannel and EmbeddedEventLoop, implementations of the NIOCore abstractions that provide fine-grained control over their execution. In general, this should only be imported by projects that plan to do some actual I/O, such as high-level protocol implementations or applications. This is our high performance core I/O layer. This provides the primary, EventLoop, and Channels for use on POSIX-based systems. Most NIO extension projects that provide things like new EventLoops and Channels or new protocol implementations should only need to depend on NIOCore. This provides the core abstractions and types for using SwiftNIO (see 'Conceptual Overview' for more details). This is an umbrella module exporting NIOCore, NIOEmbedded and NIOPosix. This package contains the following products: Within this repository we have a number of products that provide different functionality. The SwiftNIO project is split across multiple repositories: Repositoryįirst-class support for macOS, iOS, tvOS, and watchOS SwiftNIO is a cross-platform asynchronous event-driven network application frameworkįor rapid development of maintainable high performance protocol servers & clients.

Apple server application