OpenStack library for messaging
Go to file
Mark McLoughlin c846cf35b8 Add a TransportURL class to the public API
Nova's cells/rpc_driver.py has some code which allows user of the REST
API to update elements of a cell's transport URL (say, the host name of
the message broker) stored in the database. To achieve this, it has
a parse_transport_url() method which breaks the URL into its constituent
parts and an unparse_transport_url() which re-forms it again after
updating some of its parts.

This is all fine and, since it's fairly specialized, it wouldn't be a
big deal to leave this code in Nova for now ... except the unparse
method looks at CONF.rpc_backend to know what scheme to use in the
returned URL if now backend was specified.

oslo.messaging registers the rpc_backend option, but the ability to
reference any option registered by the library should not be relied upon
by users of the library. Imagine, for instance, if we renamed the option
in future (with backwards compat for old configurations), then this
would mean API breakage.

So, long story short - an API along these lines makes some sense, but
especially since not having it would mean we'd need to add some way to
query the name of the transport driver.

In this commit, we add a simple new TransportURL class:

  >>> url = messaging.TransportURL.parse(cfg.CONF, 'foo:///')
  >>> str(url), url
  ('foo:///', <TransportURL transport='foo'>)
  >>> url.hosts.append(messaging.TransportHost(hostname='localhost'))
  >>> str(url), url
  ('foo://localhost/', <TransportURL transport='foo', hosts=[<TransportHost hostname='localhost'>]>)
  >>> url.transport = None
  >>> str(url), url
  ('kombu://localhost/', <TransportURL transport='kombu', hosts=[<TransportHost hostname='localhost'>]>)
  >>> cfg.CONF.set_override('rpc_backend', 'bar')
  >>> str(url), url
  ('bar://localhost/', <TransportURL transport='bar', hosts=[<TransportHost hostname='localhost'>]>)

The TransportURL.parse() method equates to parse_transport_url() and
TransportURL.__str__() equates to unparse_transport().

The transport drivers are also updated to take a TransportURL as a
required argument, which simplifies the handling of transport URLs in
the drivers.

Change-Id: Ic04173476329858e4a2c2d2707e9d4aeb212d127
2013-08-12 23:30:43 +01:00
doc/source Add a TransportURL class to the public API 2013-08-12 23:30:43 +01:00
oslo Add a TransportURL class to the public API 2013-08-12 23:30:43 +01:00
tests Add a TransportURL class to the public API 2013-08-12 23:30:43 +01:00
.gitignore Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
.gitreview Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
.testr.conf Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
CONTRIBUTING.rst Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
LICENSE Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
MANIFEST.in Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
openstack-common.conf Add missing gettextutils 2013-07-27 15:49:48 +01:00
README.rst Add oslo.messaging project infrastructure 2013-06-15 08:43:50 +01:00
requirements.txt Temporarily add eventlet to requirements 2013-07-27 15:54:03 +01:00
setup.cfg Ensure namespace package is installed 2013-08-12 14:35:33 +01:00
setup.py Ensure namespace package is installed 2013-08-12 14:35:33 +01:00
test-requirements.txt Add simple rabbit driver unit test 2013-07-27 15:54:06 +01:00
tox.ini Simplify public symbol exports 2013-06-24 12:52:30 +01:00

Oslo Messaging Library

The Oslo messaging API supports RPC and notifications over a number of different messsaging transports.