BERTREM

By Benjamin Black ([email protected])

BERTREM is a BERT-RPC client and server implementation that uses an EventMachine server to accept incoming connections, and then delegates the request to loadable Ruby handlers. BERTREM is derived from Ernie, by Tom Preston-Warner.

See the full BERT-RPC specification at bert-rpc.org.

BERTREM currently supports the following BERT-RPC features:

• call requests
• cast requests

Installation

$ gem install bertrem -s http://gemcutter.org

Example Handler

A simple Ruby module for use in a BERTREM server:

require 'bertrem'

module Calc
  def add(a, b)
    a + b
  end
end

Example Server

A simple BERTREM server using the Calc module defined above:

require 'eventmachine'
require 'bertrem'

EM.run {
  BERTREM::Server.expose(:calc, Calc)
  svc = BERTREM::Server.start('localhost', 9999)
}

Logging

You can have logging sent to a file by adding these lines to your handler:

logfile('/var/log/bertrem.log')
loglevel(Logger::INFO)

This will log startup info, requests, and error messages to the log. Choosing Logger::DEBUG will include the response (be careful, doing this can generate very large log files).

Using the BERTRPC gem to make calls to BERTREM

The BERTREM client supports persistent connections, so you can send multiple requests over the same service connection and responses will return in the order the requests were sent:

require 'eventmachine'
require 'bertrem'

EM.run {
  client = BERTREM::Client.service('localhost', 9999, true)
  rpc = client.call.calc.add(6, 2)
  rpc.callback { |res|
    puts "Got response! -> #{res}"
  }

  rpc = client.call.calc.add(2, 2)
  rpc.callback { |res|
    puts "Got response! -> #{res}"
  }
}
# Got response! -> 8
# Got response! -> 4

Alternatively, you can make BERT-RPC calls from Ruby with the BERTRPC gem:

require 'bertrpc'

svc = BERTRPC::Service.new('localhost', 8000)
svc.call.calc.add(1, 2)
# => 3

Contribute

If you'd like to hack on BERTREM, start by forking my repo on GitHub:

http://github.com/b/bertrem

To get all of the dependencies, install the gem first

The best way to get your changes merged back into core is as follows:

1. Clone down your fork
2. Create a topic branch to contain your change
3. Hack away
4. Add tests and make sure everything still passes by running rake
5. If you are adding new functionality, document it in the README.md
6. Do not change the version number, I will do that on my end
7. If necessary, rebase your commits into logical chunks, without errors
8. Push the branch up to GitHub
9. Send me (b) a pull request for your branch

Copyright

Copyright (c) 2009 Benjamin Black. See LICENSE for details.