Public Member Functions
	__init__ (self)

	is_suspended (self)

	suspend (self, suspended_time, suspend_reason)

	resume (self)

Public Attributes
	lock

	continuous_errors

	suspend_end_time

	suspend_reason

Static Private Attributes
str	__slots__ = 'suspend_end_time', 'suspend_reason', 'continuous_errors', 'lock'

Detailed Description

Class to handle suspend state.

Definition at line 22 of file abstract.py.

Constructor & Destructor Documentation

◆ init()

searx.search.processors.abstract.SuspendedStatus.__init__ ( self )

Definition at line 27 of file abstract.py.

    def __init__(self):
        self.lock = threading.Lock()
        self.continuous_errors = 0
        self.suspend_end_time = 0
        self.suspend_reason = None
 

Member Function Documentation

◆ is_suspended()

searx.search.processors.abstract.SuspendedStatus.is_suspended ( self )

Definition at line 34 of file abstract.py.

    def is_suspended(self):
        return self.suspend_end_time >= default_timer()
 

References searx.search.processors.abstract.SuspendedStatus.suspend_end_time.

◆ resume()

searx.search.processors.abstract.SuspendedStatus.resume ( self )

Definition at line 50 of file abstract.py.

    def resume(self):
        with self.lock:
            # reset the suspend variables
            self.continuous_errors = 0
            self.suspend_end_time = 0
            self.suspend_reason = None
 
 

References searx.search.processors.abstract.SuspendedStatus.continuous_errors, searx.metrics.models.CounterStorage.lock, searx.search.processors.abstract.SuspendedStatus.lock, searx.search.processors.abstract.SuspendedStatus.suspend_end_time, and searx.search.processors.abstract.SuspendedStatus.suspend_reason.

◆ suspend()

searx.search.processors.abstract.SuspendedStatus.suspend	(	self,
		suspended_time,
		suspend_reason )

Definition at line 37 of file abstract.py.

    def suspend(self, suspended_time, suspend_reason):
        with self.lock:
            # update continuous_errors / suspend_end_time
            self.continuous_errors += 1
            if suspended_time is None:
                suspended_time = min(
                    settings['search']['max_ban_time_on_fail'],
                    self.continuous_errors * settings['search']['ban_time_on_fail'],
                )
            self.suspend_end_time = default_timer() + suspended_time
            self.suspend_reason = suspend_reason
            logger.debug('Suspend for %i seconds', suspended_time)
 

References searx.search.processors.abstract.SuspendedStatus.continuous_errors, searx.metrics.models.CounterStorage.lock, searx.search.processors.abstract.SuspendedStatus.lock, searx.search.processors.abstract.SuspendedStatus.suspend_end_time, and searx.search.processors.abstract.SuspendedStatus.suspend_reason.

Member Data Documentation

◆ slots

str searx.search.processors.abstract.SuspendedStatus.__slots__ = 'suspend_end_time', 'suspend_reason', 'continuous_errors', 'lock'

staticprivate

Definition at line 25 of file abstract.py.

◆ continuous_errors

searx.search.processors.abstract.SuspendedStatus.continuous_errors

Definition at line 29 of file abstract.py.

Referenced by searx.search.processors.abstract.SuspendedStatus.resume(), and searx.search.processors.abstract.SuspendedStatus.suspend().

◆ lock

searx.search.processors.abstract.SuspendedStatus.lock

Definition at line 28 of file abstract.py.

Referenced by searx.metrics.models.CounterStorage.add(), searx.metrics.models.CounterStorage.clear(), searx.metrics.models.CounterStorage.configure(), searx.metrics.models.CounterStorage.dump(), searx.search.processors.abstract.SuspendedStatus.resume(), and searx.search.processors.abstract.SuspendedStatus.suspend().

◆ suspend_end_time

searx.search.processors.abstract.SuspendedStatus.suspend_end_time

Definition at line 30 of file abstract.py.

Referenced by searx.search.processors.abstract.SuspendedStatus.is_suspended(), searx.search.processors.abstract.SuspendedStatus.resume(), and searx.search.processors.abstract.SuspendedStatus.suspend().

◆ suspend_reason

searx.search.processors.abstract.SuspendedStatus.suspend_reason

Definition at line 31 of file abstract.py.