ocrd_network.rabbitmq_utils package

class ocrd_network.rabbitmq_utils.RMQConsumer(host: str = 'localhost', port: int = 5672, vhost: str = '/')

Bases: RMQConnector

authenticate_and_connect(username: str, password: str) → None

setup_defaults() → None

get_one_message(queue_name: str, auto_ack: bool = False) → Any | None

configure_consuming(queue_name: str, callback_method: Any) → None

start_consuming() → None

get_waiting_message_count() → int | None

ack_message(delivery_tag: int) → None

class ocrd_network.rabbitmq_utils.RMQConnector(host: str = 'localhost', port: int = 5672, vhost: str = '/')

Bases: object

static declare_and_bind_defaults(connection: BlockingConnection, channel: BlockingChannel) → None

static open_blocking_connection(credentials: PlainCredentials, host: str = 'localhost', port: int = 5672, vhost: str = '/') → BlockingConnection

static open_blocking_channel(connection: BlockingConnection) → BlockingChannel | None

static exchange_bind(channel: BlockingChannel, destination_exchange: str, source_exchange: str, routing_key: str, arguments: Any | None = None) → None

static exchange_declare(channel: BlockingChannel, exchange_name: str, exchange_type: str, passive: bool = False, durable: bool = False, auto_delete: bool = False, internal: bool = False, arguments: Any | None = None) → None

static exchange_delete(channel: BlockingChannel, exchange_name: str, if_unused: bool = False) → None

static exchange_unbind(channel: BlockingChannel, destination_exchange: str, source_exchange: str, routing_key: str, arguments: Any | None = None) → None

static queue_bind(channel: BlockingChannel, queue_name: str, exchange_name: str, routing_key: str, arguments: Any | None = None) → None

static queue_declare(channel: BlockingChannel, queue_name: str, passive: bool = False, durable: bool = False, exclusive: bool = False, auto_delete: bool = False, arguments: Any | None = None) → None

static queue_delete(channel: BlockingChannel, queue_name: str, if_unused: bool = False, if_empty: bool = False) → None

static queue_purge(channel: BlockingChannel, queue_name: str) → None

static queue_unbind(channel: BlockingChannel, queue_name: str, exchange_name: str, routing_key: str, arguments: Any | None = None) → None

static set_qos(channel: BlockingChannel, prefetch_size: int = 0, prefetch_count: int = 1, global_qos: bool = False) → None

static confirm_delivery(channel: BlockingChannel) → None

static basic_publish(channel: BlockingChannel, exchange_name: str, routing_key: str, message_body: bytes, properties: BasicProperties) → None

class ocrd_network.rabbitmq_utils.RMQPublisher(host: str = 'localhost', port: int = 5672, vhost: str = '/')

Bases: RMQConnector

authenticate_and_connect(username: str, password: str) → None

setup_defaults() → None

create_queue(queue_name: str, exchange_name: str | None = None, exchange_type: str | None = None, passive: bool = False) → None

publish_to_queue(queue_name: str, message: bytes, exchange_name: str | None = None, properties: BasicProperties | None = None) → None

enable_delivery_confirmations() → None

class ocrd_network.rabbitmq_utils.OcrdProcessingMessage(job_id: str, processor_name: str, created_time: int, input_file_grps: List[str], output_file_grps: List[str] | None, path_to_mets: str | None, workspace_id: str | None, page_id: str | None, result_queue_name: str | None, callback_url: str | None, internal_callback_url: str | None, parameters: Dict[str, Any] | None = None)

Bases: object

static encode_yml(ocrd_processing_message: OcrdProcessingMessage) → bytes

static decode_yml(ocrd_processing_message: bytes) → OcrdProcessingMessage

class ocrd_network.rabbitmq_utils.OcrdResultMessage(job_id: str, state: str, path_to_mets: str | None = None, workspace_id: str | None = None)

Bases: object

static encode_yml(ocrd_result_message: OcrdResultMessage) → bytes

static decode_yml(ocrd_result_message: bytes) → OcrdResultMessage

Submodules

• ocrd_network.rabbitmq_utils.connector module
  • RMQConnector
    • RMQConnector.declare_and_bind_defaults()
    • RMQConnector.open_blocking_connection()
    • RMQConnector.open_blocking_channel()
    • RMQConnector.exchange_bind()
    • RMQConnector.exchange_declare()
    • RMQConnector.exchange_delete()
    • RMQConnector.exchange_unbind()
    • RMQConnector.queue_bind()
    • RMQConnector.queue_declare()
    • RMQConnector.queue_delete()
    • RMQConnector.queue_purge()
    • RMQConnector.queue_unbind()
    • RMQConnector.set_qos()
    • RMQConnector.confirm_delivery()
    • RMQConnector.basic_publish()
• ocrd_network.rabbitmq_utils.constants module
• ocrd_network.rabbitmq_utils.consumer module
  • RMQConsumer
    • RMQConsumer.authenticate_and_connect()
    • RMQConsumer.setup_defaults()
    • RMQConsumer.get_one_message()
    • RMQConsumer.configure_consuming()
    • RMQConsumer.start_consuming()
    • RMQConsumer.get_waiting_message_count()
    • RMQConsumer.ack_message()
• ocrd_network.rabbitmq_utils.ocrd_messages module
  • OcrdProcessingMessage
    • OcrdProcessingMessage.encode_yml()
    • OcrdProcessingMessage.decode_yml()
  • OcrdResultMessage
    • OcrdResultMessage.encode_yml()
    • OcrdResultMessage.decode_yml()
• ocrd_network.rabbitmq_utils.publisher module
  • RMQPublisher
    • RMQPublisher.authenticate_and_connect()
    • RMQPublisher.setup_defaults()
    • RMQPublisher.create_queue()
    • RMQPublisher.publish_to_queue()
    • RMQPublisher.enable_delivery_confirmations()