Skip to content

socketry/protocol-redis

Repository files navigation

Protocol::Redis

Implements the RESP2 and RESP3 Redis protocols.

Development Status

Installation

Add this line to your application's Gemfile:

gem 'protocol-redis'

And then execute:

$ bundle

Or install it yourself as:

$ gem install protocol-redis

Usage

sockets = Socket.pair(Socket::PF_UNIX, Socket::SOCK_STREAM)

client = Protocol::Redis::Connection.new(sockets.first)
server = Protocol::Redis::Connection.new(sockets.last)

client.write_object("Hello World!")
puts server.read_object
# => "Hello World!"

Development

Run tests:

bundle exec bake test

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.