Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swiftnioextras/swift-nio-redis
A high performance Redis protocol (RESP) implementation for SwiftNIO
https://github.com/swiftnioextras/swift-nio-redis
asyncio redis redis-client swift-framework swift-nio swift-server swift4
Last synced: 25 days ago
JSON representation
A high performance Redis protocol (RESP) implementation for SwiftNIO
- Host: GitHub
- URL: https://github.com/swiftnioextras/swift-nio-redis
- Owner: SwiftNIOExtras
- License: apache-2.0
- Created: 2018-04-10T21:21:35.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-29T23:05:56.000Z (10 months ago)
- Last Synced: 2024-10-09T16:30:56.549Z (about 1 month ago)
- Topics: asyncio, redis, redis-client, swift-framework, swift-nio, swift-server, swift4
- Language: Swift
- Homepage:
- Size: 99.6 KB
- Stars: 29
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SwiftNIO Redis
SwiftNIO Redis is a Swift package that contains a high performance
[Redis protocol](https://redis.io/topics/protocol)
implementation for
[SwiftNIO](https://github.com/apple/swift-nio).
This is a **standalone project** and has no other dependencies but
[SwiftNIO](https://github.com/apple/swift-nio).
Apart from the protocol implementation which can encode and decode
[RESP](https://redis.io/topics/protocol) (REdis Serialization Protocol),
we also provide a [Redis client module](https://github.com/NozeIO/swift-nio-redis-client)
build on top.
What is Redis?
[Redis](https://redis.io/) is a highly scalable in-memory data structure store,
used as a database, cache and message broker.
For example it can be used to implement a session store backing a web backend
using its "expiring keys" feature,
or it can be used as a relay to implement a chat server using its builtin
[PubSub](https://redis.io/topics/pubsub)
features.
This Swift package includes the RESP protocol implementation.
A simple Redis client can be found on
[swift-nio-redis-client](https://github.com/NozeIO/swift-nio-redis-client).
We also provide an actual [Redis Server](https://github.com/NozeIO/redi-s)
written in Swift, using SwiftNIO and SwiftNIO Redis.
## Performance
This implementation is focused on performance.
It tries to reuse NIO `ByteBuffer`s as much as possible to avoid copies.
The parser is based on a state machine, not on a buffering
`ByteToMessageDecoder`/Encoder.
That doesn't make it nice, but efficient ;-)
## Importing the module using Swift Package Manager
An example `Package.swift `importing the necessary modules:
```swift
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "RedisTests",
dependencies: [
.package(url: "https://github.com/SwiftNIOExtras/swift-nio-redis.git",
from: "0.9.2")
],
targets: [
.target(name: "MyProtocolTool",
dependencies: [ "NIORedis" ])
]
)
```
## Using the SwiftNIO Redis protocol handler
The RESP protocol is implemented as a regular
`ChannelHandler`, similar to `NIOHTTP1`.
It takes incoming `ByteBuffer` data, parses that, and emits `RESPValue`
items.
Same the other way around, the user writes `RESPValue` (or `RESPEncodable`)
objects, and the handler renders such into `ByteBuffer`s.
The [NIORedis module](Sources/NIORedis/README.md) has a litte more
information.
To add the RESP handler to a NIO Channel pipeline, the `configureRedisPipeline`
method is called, e.g.:
```swift
import NIORedis
bootstrap.channelInitializer { channel in
channel.pipeline
.configureRedisPipeline()
.then { ... }
}
```
## Status
The
[protocol implementation](Sources/NIORedis/)
is considered complete. There are a few open ends
in the `telnet` variant, yet the regular binary protocol is considered done.
### Who
Brought to you by
[ZeeZide](http://zeezide.de).
We like
[feedback](https://twitter.com/ar_institute),
GitHub stars,
cool [contract work](http://zeezide.com/en/services/services.html),
presumably any form of praise you can think of.