/usr/share/doc/python-oslo.messaging/html/_sources/contributor/driver-dev-guide.rst.txt is in python-oslo.messaging 5.35.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | ---------------------------------------
Guide for Transport Driver Implementors
---------------------------------------
.. currentmodule:: oslo_messaging
.. automodule:: 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
===============
.. autoclass:: IncomingMessage
:members:
==================
RpcIncomingMessage
==================
.. autoclass:: RpcIncomingMessage
:members:
========
Listener
========
.. autoclass:: Listener
:members:
=================
PollStyleListener
=================
.. autoclass:: PollStyleListener
:members:
==========
BaseDriver
==========
.. autoclass:: BaseDriver
:members:
|