openstack/oslo.messaging
Code Issues Proposed changes
296d93d586
oslo.messaging/doc/source/driver-dev-guide.rst
Kenneth Giusti adf4cd9d05 Document the transport backend driver interface 
Add detailed documentation to the driver API to help driver developers
create drivers that behave consistently.  Specifically prescribes a
set of operational characteristics that a driver must conform to in
order to provide consistent behavior across different implementations.

Change-Id: Icb251ee724f9a0ac4fede702a367910de4ba95e3
2016-11-22 08:11:22 -05:00

1.6 KiB
Raw Blame History

Guide for Transport Driver Implementors

oslo_messaging

oslo_messaging._drivers.base

Introduction

This document is a best practices guide for the developer interested in creating a new transport driver for Oslo.Messaging. It should also be used by maintainers as a reference for proper driver behavior. This document will describe the driver interface and prescribe the expected behavior of any driver implemented to this interface.

Note well: The API described in this document is internal to the oslo.messaging library and therefore private. Under no circumstances should this API be referenced by code external to the oslo.messaging library.

Driver Interface

The driver interface is defined by a set of abstract base classes. The developer creates a driver by defining concrete classes from these bases. The derived classes embody the logic that is specific for the messaging back-end that is to be supported.

These base classes are defined in the base.py file in the _drivers subdirectory.

IncomingMessage

IncomingMessage

RpcIncomingMessage

RpcIncomingMessage

Listener

Listener

PollStyleListener

PollStyleListener

BaseDriver

BaseDriver