Contents

# Skein

[Skein](https://en.wikipedia.org/wiki/V_formation) is a RabbitMQ-based standard
and implementation for Ruby that defines how to dispatch
[JSON-RPC](http://json-rpc.org) jobs over AMQP.

## Dependencies

This library requires an active AMQP server like [RabbitMQ](http://rabbitmq.com)
and a Ruby driver for AMQP like [Bunny](http://rubybunny.info) or
[March Hare](http://rubymarchhare.info).

Both jRuby and MRI Ruby are supported.

## Installation

The default [Bundler](http://bundler.io) configuration should be a good place
to start:

    bundle install

## Configuration

For testing, set up `config/rabbitmq.yml` with configuration parameters that
define how to connect to RabbitMQ.

## Client Modes

### RPC

An RPC client can make blocking or non-blocking calls. By default calls are
blocking, but they can be made non-blocking by adding `!` to the end of the
method name. For example:

    client = Skein::Client.rpc('test_queue')

    client.request!(test: 'data')

    client.close

Note that non-blocking calls are fire-and-forget, there is no way of knowing
if that operation succeeded or failed.

### Worker

The back-end that receives and processes RPC calls is instantiated as
a `Skein::Client::Worker` instance:

    class Responder < Skein::Client::Worker
      def request
        {
          result: true
        }
      end
    end

    Responder.new('test_queue')

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
skein-0.3.7	README.md
skein-0.3.6	README.md
skein-0.3.5	README.md
skein-0.3.2	README.md
skein-0.3.1	README.md
skein-0.3.0	README.md