fea8bb64ba
This patch builds a small hierarchy of event objects that represent the payload for callback notification events. The overall goal of this work is to begin moving away from the existing unstructured **kwargs passed today and standardize on a common set of event payload objects; the beginning of such contained herein. A PoC/dummy patch for neutron is provided in [1] that exemplifies consumption of the new API by: - Removes neutron.callbacks and moves all uses to neutron_lib.callbacks. - Neutron uses of callbacks for BEFORE_RESPONSE events now use neutron-lib. - Neutron uses of callbacks for ROUTER and PROCESS resource events now use neutron-lib. - Neutron UTs updated to pass with this patch. For existing discussion on this approach please see [2][3]. Co-Authored-By: Armando Migliaccio <armamig@gmail.com> [1] https://review.openstack.org/400404/ [2] https://review.openstack.org/#/c/345718 [3] https://review.openstack.org/#/c/342304 Change-Id: If76457b1f0d5d3479e394d0dba3b22a90928f0f2
55 lines
1.7 KiB
Python
55 lines
1.7 KiB
Python
# 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.
|
|
|
|
from neutron_lib.callbacks import manager
|
|
|
|
|
|
# TODO(armax): consider adding locking
|
|
_CALLBACK_MANAGER = None
|
|
|
|
|
|
def _get_callback_manager():
|
|
global _CALLBACK_MANAGER
|
|
if _CALLBACK_MANAGER is None:
|
|
_CALLBACK_MANAGER = manager.CallbacksManager()
|
|
return _CALLBACK_MANAGER
|
|
|
|
|
|
def subscribe(callback, resource, event):
|
|
_get_callback_manager().subscribe(callback, resource, event)
|
|
|
|
|
|
def unsubscribe(callback, resource, event):
|
|
_get_callback_manager().unsubscribe(callback, resource, event)
|
|
|
|
|
|
def unsubscribe_by_resource(callback, resource):
|
|
_get_callback_manager().unsubscribe_by_resource(callback, resource)
|
|
|
|
|
|
def unsubscribe_all(callback):
|
|
_get_callback_manager().unsubscribe_all(callback)
|
|
|
|
|
|
# NOTE(boden): This method is deprecated in favor of publish() and will be
|
|
# removed in Queens, but not deprecation message to reduce log flooding
|
|
def notify(resource, event, trigger, **kwargs):
|
|
_get_callback_manager().notify(resource, event, trigger, **kwargs)
|
|
|
|
|
|
def publish(resource, event, trigger, payload=None):
|
|
_get_callback_manager().publish(resource, event, trigger, payload=payload)
|
|
|
|
|
|
def clear():
|
|
_get_callback_manager().clear()
|