Source code for pynenc_rabbitmq.conf.config_rabbitmq

from cistell import ConfigField
from pynenc.conf.config_base import ConfigPynencBase




class ConfigRabbitMq(ConfigPynencBase):
    """
    Configuration for RabbitMQ client connections and messaging.

    This class provides configuration settings for RabbitMQ connections, queues,
    and message handling used throughout the Pynenc system.

    :cvar ConfigField[str] rabbitmq_host:
        The hostname of the RabbitMQ server. Defaults to 'localhost'.

    :cvar ConfigField[int] rabbitmq_port:
        The AMQP port for message broker connections. Defaults to 5672.
        This is the port used for all message publishing and consuming operations.

    :cvar ConfigField[str] rabbitmq_username:
        The username to use when connecting to the RabbitMQ server. Defaults to 'guest'.

    :cvar ConfigField[str] rabbitmq_password:
        The password to use when connecting to the RabbitMQ server. Defaults to 'guest'.

    :cvar ConfigField[str] rabbitmq_virtual_host:
        The virtual host to use on the RabbitMQ server. Defaults to '/'.

    :cvar ConfigField[str] rabbitmq_queue_prefix:
        The prefix to use for all RabbitMQ queue names. Defaults to 'pynenc'.

    :cvar ConfigField[str] rabbitmq_exchange_name:
        The name of the RabbitMQ exchange to use for message routing. Defaults to
        'pynenc.direct'.

    :cvar ConfigField[str] rabbitmq_exchange_type:
        The type of RabbitMQ exchange to create. Defaults to 'direct'.

    :cvar ConfigField[int] rabbitmq_connection_attempts:
        The maximum number of connection attempts before failing. Defaults to 3.

    :cvar ConfigField[float] rabbitmq_retry_delay:
        The delay in seconds between connection retry attempts. Defaults to 5.0.

    :cvar ConfigField[int] rabbitmq_heartbeat:
        The heartbeat interval in seconds for the RabbitMQ connection. Defaults to 600
        (10 minutes). Set to 0 to disable.

    :cvar ConfigField[int] rabbitmq_prefetch_count:
        The number of unacknowledged messages that can be delivered to a consumer.
        Defaults to 10.

    :cvar ConfigField[int] rabbitmq_message_ttl:
        The message time-to-live in milliseconds. Defaults to 86400000 (24 hours).
        Set to 0 to disable TTL.

    :cvar ConfigField[bool] rabbitmq_confirm_delivery:
        Whether to enable publisher confirms for reliable message delivery. Defaults to
        True.

    :cvar ConfigField[str] rabbitmq_pika_log_level:
        Log level for pika library logs. Defaults to 'WARNING' to reduce noise.
        Valid values: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'.
        Set to 'INFO' to see connection details during debugging.

    :cvar ConfigField[int] rabbitmq_retry_max_attempts:
        Maximum number of retry attempts for RabbitMQ operations. Defaults to 0 (infinite).
        Set to a positive number to limit retries.

    :cvar ConfigField[float] rabbitmq_retry_initial_delay:
        Initial delay in seconds before first retry. Defaults to 1.0.

    :cvar ConfigField[float] rabbitmq_retry_max_delay:
        Maximum delay in seconds between retries. Defaults to 60.0.

    :cvar ConfigField[float] rabbitmq_retry_exponential_base:
        Base for exponential backoff calculation. Defaults to 2.0.
    """

    # Connection settings
    rabbitmq_host = ConfigField("localhost")
    rabbitmq_port = ConfigField(5672)
    rabbitmq_username = ConfigField("guest")
    rabbitmq_password = ConfigField("guest")
    rabbitmq_virtual_host = ConfigField("/")

    # Queue and exchange configuration
    rabbitmq_queue_prefix = ConfigField("pynenc")
    rabbitmq_exchange_name = ConfigField("pynenc.direct")
    rabbitmq_exchange_type = ConfigField("direct")

    # Connection behavior
    rabbitmq_connection_attempts = ConfigField(3)
    rabbitmq_retry_delay = ConfigField(5.0)
    rabbitmq_heartbeat = ConfigField(600)

    # Message handling
    rabbitmq_prefetch_count = ConfigField(10)
    rabbitmq_message_ttl = ConfigField(86400000)  # 24 hours in milliseconds
    rabbitmq_confirm_delivery = ConfigField(True)
    rabbitmq_pika_log_level = ConfigField("WARNING")

    # Retry settings for operations (exponential backoff)
    rabbitmq_retry_max_attempts = ConfigField(0)  # 0 = infinite
    rabbitmq_retry_initial_delay = ConfigField(1.0)
    rabbitmq_retry_max_delay = ConfigField(60.0)
    rabbitmq_retry_exponential_base = ConfigField(2.0)