Source code for ironic.common.rpc_service

# -*- encoding: utf-8 -*-
# Copyright © 2012 eNovance <>
# 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
# 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 signal

from oslo_config import cfg
from oslo_log import log
import oslo_messaging as messaging
from oslo_service import service
from oslo_utils import importutils

from ironic.common import context
from ironic.common.json_rpc import server as json_rpc
from ironic.common import rpc
from ironic.objects import base as objects_base

LOG = log.getLogger(__name__)

[docs]class RPCService(service.Service): def __init__(self, host, manager_module, manager_class): super(RPCService, self).__init__() = host manager_module = importutils.try_import(manager_module) manager_class = getattr(manager_module, manager_class) self.manager = manager_class(host, manager_module.MANAGER_TOPIC) self.topic = self.manager.topic self.rpcserver = None self.deregister = True
[docs] def start(self): super(RPCService, self).start() admin_context = context.get_admin_context() serializer = objects_base.IronicObjectSerializer(is_server=True) # Perform preparatory actions before starting the RPC listener self.manager.prepare_host() if CONF.rpc_transport == 'json-rpc': self.rpcserver = json_rpc.WSGIService(self.manager, serializer) else: target = messaging.Target(topic=self.topic, endpoints = [self.manager] self.rpcserver = rpc.get_server(target, endpoints, serializer) self.rpcserver.start() self.handle_signal() self.manager.init_host(admin_context)'Created RPC server for service %(service)s on host ' '%(host)s.', {'service': self.topic, 'host':})
[docs] def stop(self): try: self.rpcserver.stop() self.rpcserver.wait() except Exception as e: LOG.exception('Service error occurred when stopping the ' 'RPC server. Error: %s', e) try: self.manager.del_host(deregister=self.deregister) except Exception as e: LOG.exception('Service error occurred when cleaning up ' 'the RPC manager. Error: %s', e) super(RPCService, self).stop(graceful=True)'Stopped RPC server for service %(service)s on host ' '%(host)s.', {'service': self.topic, 'host':})
def _handle_signal(self, signo, frame):'Got signal SIGUSR1. Not deregistering on next shutdown ' 'of service %(service)s on host %(host)s.', {'service': self.topic, 'host':}) self.deregister = False
[docs] def handle_signal(self): """Add a signal handler for SIGUSR1. The handler ensures that the manager is not deregistered when it is shutdown. """ signal.signal(signal.SIGUSR1, self._handle_signal)