Top

forestbus module

The forestbus package provides a Python client API for connecting to a Forest Bus cluster.

Connections are made using CBOR encoded RPC calls over TCP. The nodes in the cluster must be started with the -cbor flag to enable connections from Python.

To connect to a Forest Bus cluster create an instance of the forest.Client class. This class will in turn create instances of cbor_rpc.Client as required.

"""
The forestbus package provides a Python client API for connecting to a Forest Bus cluster.

Connections are made using CBOR encoded RPC calls over TCP.  The nodes in the cluster must be started with the -cbor flag to enable connections from Python.

To connect to a Forest Bus cluster create an instance of the forest.Client class.  This class will in turn create instances of cbor_rpc.Client as required.

"""

__version__ = "1.0.1"

Sub-modules

forestbus.cbor_rpc

The cbor_rpc module provides a multi-thread safe client API for making RPC calls encoded with CBOR. The RPC protocol supported is that defined by Go (see http://golang.org/pkg/net/rpc/), encoded with the CBOR (see http://cbor.io) codec. This package is used internally by the Forest Bus client.

forestbus.forest

The forest module provides an easy to use Python client API for interacting with a Forest Bus cluster.