Timeout

Wait for a simulated time to pass.

Timeout

Bases: Event

Timeout event for sleeping.

Source code in src/asimpy/timeout.py

class Timeout(Event):
    """Timeout event for sleeping."""

    def __init__(self, env: "Environment", delay: float | int):
        """
        Construct timeout.

        Args:
            env: simulation environment.
            delay: how long to wait.

        Raises:
            ValueError: for invalid `delay`.
        """
        _validate(delay >= 0, "require non-negative timeout not {delay}")
        super().__init__(env)
        env.schedule(env.now + delay, self._fire)

    def _fire(self):
        """Handle cancellation case."""
        if self._cancelled:
            return NO_TIME
        self.succeed()

__init__(env, delay)

Construct timeout.

Parameters:

Name	Type	Description	Default
env	Environment	simulation environment.	required
delay	float | int	how long to wait.	required

Raises:

Type	Description
ValueError	for invalid delay.

Source code in src/asimpy/timeout.py

def __init__(self, env: "Environment", delay: float | int):
    """
    Construct timeout.

    Args:
        env: simulation environment.
        delay: how long to wait.

    Raises:
        ValueError: for invalid `delay`.
    """
    _validate(delay >= 0, "require non-negative timeout not {delay}")
    super().__init__(env)
    env.schedule(env.now + delay, self._fire)