Module csw.Cancellable

Classes

class Cancellable

Expand source code

class Cancellable:
    """
    API for a scheduled periodic task, that allows it to be cancelled.
    """
    def cancel(self) -> bool:
        """
        Cancels this Cancellable and returns true if that was successful.
        If this cancellable was (concurrently) cancelled already, then this method
        will return false.

        Returns:
            whether or not the cancellable was cancelled successfully
        """
        pass

API for a scheduled periodic task, that allows it to be cancelled.

Subclasses

• TimerCancellable

Methods

def cancel(self) ‑> bool

Expand source code

def cancel(self) -> bool:
    """
    Cancels this Cancellable and returns true if that was successful.
    If this cancellable was (concurrently) cancelled already, then this method
    will return false.

    Returns:
        whether or not the cancellable was cancelled successfully
    """
    pass

Cancels this Cancellable and returns true if that was successful. If this cancellable was (concurrently) cancelled already, then this method will return false.

Returns

whether or not the cancellable was cancelled successfully