b3d7e03bda
Each service implemented the get_backdoor_port method individually. This patch moves the implementation of this method to the base rpc API instead, and removes the now unnecessary code from each of the services. The server side method was left on all of the managers for rpc backwards copmatibility. They can be removed on the next major rpc version bump of those APIs. Part of blueprint base-rpc-api. Change-Id: Ia8838fafd80eb86a1c2d66f5e97370042d8d8c53
81 lines
2.6 KiB
Python
81 lines
2.6 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.
|
|
#
|
|
|
|
"""
|
|
Base RPC client and server common to all services.
|
|
"""
|
|
|
|
from nova.openstack.common import jsonutils
|
|
from nova.openstack.common import rpc
|
|
import nova.openstack.common.rpc.proxy as rpc_proxy
|
|
|
|
|
|
_NAMESPACE = 'baseapi'
|
|
|
|
|
|
class BaseAPI(rpc_proxy.RpcProxy):
|
|
"""Client side of the base rpc API.
|
|
|
|
API version history:
|
|
|
|
1.0 - Initial version.
|
|
1.1 - Add get_backdoor_port
|
|
"""
|
|
|
|
#
|
|
# NOTE(russellb): This is the default minimum version that the server
|
|
# (manager) side must implement unless otherwise specified using a version
|
|
# argument to self.call()/cast()/etc. here. It should be left as X.0 where
|
|
# X is the current major API version (1.0, 2.0, ...). For more information
|
|
# about rpc API versioning, see the docs in
|
|
# openstack/common/rpc/dispatcher.py.
|
|
#
|
|
BASE_RPC_API_VERSION = '1.0'
|
|
|
|
def __init__(self, topic):
|
|
super(BaseAPI, self).__init__(topic=topic,
|
|
default_version=self.BASE_RPC_API_VERSION)
|
|
self.namespace = _NAMESPACE
|
|
|
|
def ping(self, context, arg, timeout=None):
|
|
arg_p = jsonutils.to_primitive(arg)
|
|
msg = self.make_namespaced_msg('ping', self.namespace, arg=arg_p)
|
|
return self.call(context, msg, timeout=timeout)
|
|
|
|
def get_backdoor_port(self, context, host):
|
|
msg = self.make_namespaced_msg('get_backdoor_port', self.namespace)
|
|
return self.call(context, msg,
|
|
topic=rpc.queue_get_for(context, self.topic, host),
|
|
version='1.1')
|
|
|
|
|
|
class BaseRPCAPI(object):
|
|
"""Server side of the base RPC API."""
|
|
|
|
RPC_API_NAMESPACE = _NAMESPACE
|
|
RPC_API_VERSION = '1.1'
|
|
|
|
def __init__(self, service_name, backdoor_port):
|
|
self.service_name = service_name
|
|
self.backdoor_port = backdoor_port
|
|
|
|
def ping(self, context, arg):
|
|
resp = {'service': self.service_name, 'arg': arg}
|
|
return jsonutils.to_primitive(resp)
|
|
|
|
def get_backdoor_port(self, context):
|
|
return self.backdoor_port
|