Russell Bryant afd1d6c0ff Help clarify rpc API with docs and a bit of code. ...

The intent of this change is to help make the rpc API a bit easier to
understand both for users of the API, and for implementors of the rpc
abstraction.

1) Add a Connection class in nova.rpc.common which defines the public
interface of the connection returned by nova.rpc.create_connection().
Update the existing implementations to inherit from this class.

2) Add documentation for the public methods in nova.rpc.

3) Rename get_impl() to __get_impl() in nova.rpc.  This function is a
private implemenation detail and should not be used outside of this
module.  Also move it to the bottom of the file so that all of the
important public API stuff comes first.

Change-Id: Id78acb59474995b7c13b2b6e7c8cd5057ec8cb0f

2011-12-22 12:51:04 -05:00

4.2 KiB

Raw Blame History

View Raw