Skip to content
Oskie RPC is an extremely simple and modular RPC library for Ruby.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
test
.gitignore
.ruby-version
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
oskie_rpc.gemspec

README.md

Oskie RPC Build Status Coverage Status

Oskie RPC is an extremely simple and modular RPC library for Ruby. Design goals include:

  • Transport independent so no dependencies on TCP/IP, IO, or any other classes.
  • Modular protocol design using the Filter Chain.
  • Supports both messages and requests (requests can be replied to, messages can't).
  • Very simple binary protocol with data encoded in JSON.
  • Easy to port to other languages.
  • Bi-directional.
  • Thread safe.

Installation

Add this line to your application's Gemfile:

gem 'oskie_rpc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install oskie_rpc

Messages

The Message class is the basic unit of work for Oskie RPC. Messages contain a few simple pieces of data:

  • command: This is how you distinguish different types of messages.
  • params: Optional data you pass in addition to a command.

Messages are fire-and-forget.

Requests

The Request class is a specialized type of message that expects a response. You use them if you need a return value value from the other end. Requests support timeouts (see below section on heartbeats). The default timeout is 60 seconds.

Responses

The Response class is used to respond to a request. In general you don't work directly with this class. Responses are sent using the respond method on a request object.

Processors

The Processor class is the engine for Oskie RPC. It is network agnostic and simply takes input, generates output, and executes callbacks.

# Create a processor and define its callbacks.
processor = OskieRpc::Processor.new do |p|
  p.on(:message) do |message|
    puts "Received message: #{message.inspect}"
  end

  p.on(:request) do |request|
    puts "Received request: #{request.inspect}"
    case request.command
    when 'echo'
      request.respond do
        request.params # Last expression of the block is the return value.
      end
    end
  end

  p.on(:output) do |output|
    puts "Generated output: #{output.inspect}"
  end
end

# Send a message.
message = OskieRpc::Message.new('chat', :message => 'hello world')
processor.deliver(message)

# Simulate receiving a request (it will be echo'ed back).
processor << "\x00\x00\x00|{\"type\":\"rpcRequest\",\"request\":{\"command\":\"echo\",\"params\":{\"foo\":\"bar\"},\"messageId\":\"6c10b3ed-9f07-44c2-8f12-3e04cb7792e2\"}}"

Heartbeats

Processors require an external clock signal to properly timeout requests. This is done on purpose so that you can integrate with the timers provided by your networking framework. An alternative is to create your own clock using a dedicated thread that periodically wakes up. Your clock should call the processor's heartbeat method to signal that time has changed. A good rule of thumb is to call this method once per second.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chadrem/oskie_rpc.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.