Skip to content

castlecraft_engineer.abstractions.event_consumer

castlecraft_engineer.abstractions.event_consumer

EventStreamConsumer

Bases: ABC

Abstract base class for consuming events from an external stream and publishing them to an internal EventBus.

Source code in src/castlecraft_engineer/abstractions/event_consumer.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class EventStreamConsumer(ABC):
    """
    Abstract base class for consuming events from an external stream
    and publishing them to an internal EventBus.
    """

    @abstractmethod
    async def run(self):
        """
        Starts the consumer loop to listen for and process events.
        This method should typically run indefinitely
        until shutdown is requested.
        """
        raise NotImplementedError

    @abstractmethod
    async def shutdown(self):
        """
        Initiates a graceful shutdown of the consumer.
        Implementations should ensure pending work is
        handled and resources are released.
        """
        raise NotImplementedError

run() abstractmethod async

Starts the consumer loop to listen for and process events. This method should typically run indefinitely until shutdown is requested.

Source code in src/castlecraft_engineer/abstractions/event_consumer.py 
10
11
12
13
14
15
16
17
@abstractmethod
async def run(self):
    """
    Starts the consumer loop to listen for and process events.
    This method should typically run indefinitely
    until shutdown is requested.
    """
    raise NotImplementedError

shutdown() abstractmethod async

Initiates a graceful shutdown of the consumer. Implementations should ensure pending work is handled and resources are released.

Source code in src/castlecraft_engineer/abstractions/event_consumer.py 
19
20
21
22
23
24
25
26
@abstractmethod
async def shutdown(self):
    """
    Initiates a graceful shutdown of the consumer.
    Implementations should ensure pending work is
    handled and resources are released.
    """
    raise NotImplementedError