80 lines
2.5 KiB
Python
80 lines
2.5 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 import worker
|
|
from oslo_service import loopingcall
|
|
|
|
|
|
class WorkerSupportServiceMixin(object):
|
|
|
|
@property
|
|
def _workers(self):
|
|
try:
|
|
return self.__workers
|
|
except AttributeError:
|
|
self.__workers = []
|
|
return self.__workers
|
|
|
|
def get_workers(self):
|
|
"""Returns a collection neutron_lib.worker.BaseWorker instances
|
|
needed by this service
|
|
"""
|
|
return list(self._workers)
|
|
|
|
def add_worker(self, worker):
|
|
"""Adds neutron_lib.worker.BaseWorker needed for this service
|
|
|
|
If a object needs to define workers thread/processes outside of API/RPC
|
|
workers then it will call this method to register worker. Should be
|
|
called on initialization stage before running services
|
|
"""
|
|
self._workers.append(worker)
|
|
|
|
def add_workers(self, workers):
|
|
"""Adds neutron_lib.worker.BaseWorker list needed for this service
|
|
|
|
The same as add_worker but adds a list of workers
|
|
"""
|
|
self._workers.extend(workers)
|
|
|
|
|
|
class PeriodicWorker(worker.BaseWorker):
|
|
"""A worker that runs a function at a fixed interval."""
|
|
|
|
def __init__(self, check_func, interval, initial_delay):
|
|
super(PeriodicWorker, self).__init__(worker_process_count=0)
|
|
|
|
self._check_func = check_func
|
|
self._loop = None
|
|
self._interval = interval
|
|
self._initial_delay = initial_delay
|
|
|
|
def start(self):
|
|
super(PeriodicWorker, self).start()
|
|
if self._loop is None:
|
|
self._loop = loopingcall.FixedIntervalLoopingCall(self._check_func)
|
|
self._loop.start(interval=self._interval,
|
|
initial_delay=self._initial_delay)
|
|
|
|
def wait(self):
|
|
if self._loop is not None:
|
|
self._loop.wait()
|
|
|
|
def stop(self):
|
|
if self._loop is not None:
|
|
self._loop.stop()
|
|
|
|
def reset(self):
|
|
self.stop()
|
|
self.wait()
|
|
self.start()
|