Home

This wiki is an attempt to provide a set of in-depth guides on how to use the various components provided by this library.

View the Changelog or Release Notes to get info on what is changing between versions.

---

Past & Future

• API Changelog - What's changed from version to version?
• API Roadmap - Future hopes and dreams.
• Contributing Guide - For tips on how to get your issue/code resolved more quickly (hint: use the correct base branch).

General Usage & API

• Installation - Get up and running.
• Compiling with protoc - Compile your .proto files to ruby.
• Compiling with rake - Subsection describing how to compile with our built-in rake tasks.
• Messages & Enums - Working with messages and enums.
• Serialization - Convert your protos to/from bytes.
• Environment Variables - List of env vars and their purposes.

RPC Services & Servers

• Services - Handling requests from clients.
• Service Filters - Think Rails controller filters. Neat.
• Servers - Servers route requests to services from clients.
• Configuring a Socket Server - Using socket transport in your rpc server.
• Configuring a ZMQ Server - Using zmq transport in your rpc server.
• ServiceDirectory & Dynamic Discovery - Configuring a cluster of servers and clients to talk to each other with next to "zero config".

RPC Clients

• Sending RPC Requests - Calling services from client processes with AJAX-like DSL.
• RPC with ActiveRemote - Client requests with an ActiveRecord-like DSL.