django-cqrs/dj_cqrs/transport/base.py

#  Copyright © 2023 Ingram Micro Inc. All rights reserved.


class BaseTransport:
    """
    CQRS pattern can be implemented over any transport (AMQP, HTTP, etc.)
    All transports need to inherit from this base class.
    Transport must be set in Django settings:

    ``` py3

        CQRS = {
            'transport': 'dj_cqrs.transport.rabbit_mq.RabbitMQTransport',
        }
    ```
    """

    consumers = {}

    @staticmethod
    def produce(payload):
        """
        Send data from master model to replicas.

        Args:
            payload (dj_cqrs.dataclasses.TransportPayload): Transport payload from master model.
        """
        raise NotImplementedError

    @staticmethod
    def consume(*args, **kwargs):
        """Receive data from master model."""
        raise NotImplementedError

    @staticmethod
    def clean_connection(*args, **kwargs):
        """Clean transport connection. Here you can close all connections that you have"""
        raise NotImplementedError