oslo.messaging/oslo/messaging/_drivers/base.py
Mark McLoughlin 2be7df70b0 Add some docstrings to driver base
Eliminates spurious missed lines from coverage report.
2013-06-15 19:13:45 +01:00

75 lines
2.0 KiB
Python

# Copyright 2013 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import abc
from oslo.messaging import exceptions
class TransportDriverError(exceptions.MessagingException):
"""Base class for transport driver specific exceptions."""
class IncomingMessage(object):
__metaclass__ = abc.ABCMeta
def __init__(self, listener, ctxt, message):
self.conf = listener.conf
self.listener = listener
self.ctxt = ctxt
self.message = message
@abc.abstractmethod
def reply(self, reply=None, failure=None):
"Send a reply or failure back to the client."
@abc.abstractmethod
def done(self):
"The message has been dispatched and replied to."
class Listener(object):
__metaclass__ = abc.ABCMeta
def __init__(self, driver, target):
self.conf = driver.conf
self.driver = driver
self.target = target
@abc.abstractmethod
def poll(self):
"Blocking until a message is pending and return IncomingMessage."
class BaseDriver(object):
__metaclass__ = abc.ABCMeta
def __init__(self, conf, url=None, default_exchange=None):
self.conf = conf
self._url = url
self._default_exchange = default_exchange
@abc.abstractmethod
def send(self, target, ctxt, message,
wait_for_reply=None, timeout=None, envelope=False):
"""Send a message to the given target."""
@abc.abstractmethod
def listen(self, target):
"""Construct a Listener for the given target."""