# tokio-kinetic

[![Build Status](https://travis-ci.org/peterdelevoryas/tokio-kinetic.svg?branch=master)](https://travis-ci.org/peterdelevoryas/tokio-kinetic)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/peterdelevoryas/tokio-kinetic/master/LICENSE)
[![Documentation](https://docs.rs/tokio-kinetic/badge.svg)](https://docs.rs/tokio-kinetic)
[![](https://img.shields.io/crates/v/tokio-kinetic.svg)](https://crates.io/crates/tokio-kinetic)

A (very early, in-progress) implementation of the
[Kinetic Protocol](https://github.com/Kinetic/kinetic-protocol)
on top of [`tokio-rs`](https://tokio.rs). This library is not completed yet!
However, if you're still interested, fire up the
[Java simulator](https://github.com/Kinetic/kinetic-java)
and try experimenting with the example client!

## Running the example client

```bash
$ git clone https://github.com/peterdelevoryas/tokio-kinetic
$ cd tokio-kinetic
$ cargo build --example client
$ # Kinetic device (Java simulator, hard-drive, etc) is running on 127.0.0.1:8123
$ RUST_LOG=debug ./target/debug/examples/client 127.0.0.1 8123
```

You should see some debug output from `tokio-rs`, as well as the frames being sent and received.

## Usage

In your `Cargo.toml`,

```toml
[dependencies]
tokio-kinetic = { git = "https://github.com/peterdelevoryas/tokio-kinetic" }
```

In your source,

```rust
extern crate tokio_kinetic;
```

If you have trouble, see the [cargo guide](http://doc.crates.io/guide.html#adding-a-dependency).

## Licensing

`tokio-kinetic` is distributed under the terms of the MIT license.
The Kinetic Protocol is licensed under Mozilla Public License 2.0,
and so I have included the Kinetic Protocol source repository,
which specifies behavior within this library, and is used in a
dependency of this library. It is included
as a submodule for users to have access to.