#   Copyright 2015 Ufora 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 threading

class Stoppable(object):
    '''provides access to a stop flag across multiple threads'''
    def __init__(self):
        self._stopFlag = self._createStopFlag()

    def _createStopFlag(self):
        return threading.Event()

    def getStopFlag(self):
        return self._stopFlag

    def shouldStop(self):
        return self._stopFlag.is_set()
        
    def resume(self):
        self._stopFlag.clear()

    def stop(self):
        self._stopFlag.set()

