# Copyright 2016 Mirantis, 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 import logging import threading import six from oslo_messaging._drivers.zmq_driver import zmq_async from oslo_messaging._drivers.zmq_driver import zmq_names from oslo_messaging._drivers.zmq_driver import zmq_version LOG = logging.getLogger(__name__) zmq = zmq_async.import_zmq() @six.add_metaclass(abc.ABCMeta) class SenderBase(object): """Base request/response sending interface.""" def __init__(self, conf): self.conf = conf self._lock = threading.Lock() self._send_versions = zmq_version.get_method_versions(self, 'send') def _get_send_version(self, version): send_version = self._send_versions.get(version) if send_version is None: raise zmq_version.UnsupportedMessageVersionError(version) return send_version @abc.abstractmethod def send(self, socket, message): """Send a message via a socket in a thread-safe manner.""" class RequestSenderBase(SenderBase): pass class AckSenderBase(SenderBase): pass class ReplySenderBase(SenderBase): pass class RequestSenderProxy(RequestSenderBase): def send(self, socket, request): assert request.msg_type in zmq_names.REQUEST_TYPES, "Request expected!" send_version = self._get_send_version(request.message_version) with self._lock: send_version(socket, request) LOG.debug("->[proxy:%(addr)s] Sending %(msg_type)s message " "%(msg_id)s to target %(target)s (v%(msg_version)s)", {"addr": list(socket.connections), "msg_type": zmq_names.message_type_str(request.msg_type), "msg_id": request.message_id, "target": request.target, "msg_version": request.message_version}) def _send_v_1_0(self, socket, request): socket.send(b'', zmq.SNDMORE) socket.send_string('1.0', zmq.SNDMORE) socket.send(six.b(str(request.msg_type)), zmq.SNDMORE) socket.send(request.routing_key, zmq.SNDMORE) socket.send_string(request.message_id, zmq.SNDMORE) socket.send_dumped([request.context, request.message]) class AckSenderProxy(AckSenderBase): def send(self, socket, ack): assert ack.msg_type == zmq_names.ACK_TYPE, "Ack expected!" send_version = self._get_send_version(ack.message_version) with self._lock: send_version(socket, ack) LOG.debug("->[proxy:%(addr)s] Sending %(msg_type)s for %(msg_id)s " "(v%(msg_version)s)", {"addr": list(socket.connections), "msg_type": zmq_names.message_type_str(ack.msg_type), "msg_id": ack.message_id, "msg_version": ack.message_version}) def _send_v_1_0(self, socket, ack): socket.send(b'', zmq.SNDMORE) socket.send_string('1.0', zmq.SNDMORE) socket.send(six.b(str(ack.msg_type)), zmq.SNDMORE) socket.send(ack.reply_id, zmq.SNDMORE) socket.send_string(ack.message_id) class ReplySenderProxy(ReplySenderBase): def send(self, socket, reply): assert reply.msg_type == zmq_names.REPLY_TYPE, "Reply expected!" send_version = self._get_send_version(reply.message_version) with self._lock: send_version(socket, reply) LOG.debug("->[proxy:%(addr)s] Sending %(msg_type)s for %(msg_id)s " "(v%(msg_version)s)", {"addr": list(socket.connections), "msg_type": zmq_names.message_type_str(reply.msg_type), "msg_id": reply.message_id, "msg_version": reply.message_version}) def _send_v_1_0(self, socket, reply): socket.send(b'', zmq.SNDMORE) socket.send_string('1.0', zmq.SNDMORE) socket.send(six.b(str(reply.msg_type)), zmq.SNDMORE) socket.send(reply.reply_id, zmq.SNDMORE) socket.send_string(reply.message_id, zmq.SNDMORE) socket.send_dumped([reply.reply_body, reply.failure]) class RequestSenderDirect(RequestSenderBase): def send(self, socket, request): assert request.msg_type in zmq_names.REQUEST_TYPES, "Request expected!" send_version = self._get_send_version(request.message_version) with self._lock: send_version(socket, request) LOG.debug("Sending %(msg_type)s message %(msg_id)s to " "target %(target)s (v%(msg_version)s)", {"msg_type": zmq_names.message_type_str(request.msg_type), "msg_id": request.message_id, "target": request.target, "msg_version": request.message_version}) def _send_v_1_0(self, socket, request): socket.send(b'', zmq.SNDMORE) socket.send_string('1.0', zmq.SNDMORE) socket.send(six.b(str(request.msg_type)), zmq.SNDMORE) socket.send_string(request.message_id, zmq.SNDMORE) socket.send_dumped([request.context, request.message]) class AckSenderDirect(AckSenderBase): def send(self, socket, ack): assert ack.msg_type == zmq_names.ACK_TYPE, "Ack expected!" send_version = self._get_send_version(ack.message_version) with self._lock: send_version(socket, ack) LOG.debug("Sending %(msg_type)s for %(msg_id)s (v%(msg_version)s)", {"msg_type": zmq_names.message_type_str(ack.msg_type), "msg_id": ack.message_id, "msg_version": ack.message_version}) def _send_v_1_0(self, socket, ack): raise NotImplementedError() class ReplySenderDirect(ReplySenderBase): def send(self, socket, reply): assert reply.msg_type == zmq_names.REPLY_TYPE, "Reply expected!" send_version = self._get_send_version(reply.message_version) with self._lock: send_version(socket, reply) LOG.debug("Sending %(msg_type)s for %(msg_id)s (v%(msg_version)s)", {"msg_type": zmq_names.message_type_str(reply.msg_type), "msg_id": reply.message_id, "msg_version": reply.message_version}) def _send_v_1_0(self, socket, reply): socket.send(reply.reply_id, zmq.SNDMORE) socket.send(b'', zmq.SNDMORE) socket.send_string('1.0', zmq.SNDMORE) socket.send(six.b(str(reply.msg_type)), zmq.SNDMORE) socket.send_string(reply.message_id, zmq.SNDMORE) socket.send_dumped([reply.reply_body, reply.failure])