Skip to content

Commit

Permalink
doc: lib/pipeline: move arch docs to module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
wagner-intevation committed Apr 26, 2023
1 parent be73294 commit 47c7b20
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions intelmq/lib/pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
# SPDX-License-Identifier: AGPL-3.0-or-later

# -*- coding: utf-8 -*-

"""
Algorithm
---------
[Receive] B RPOP LPUSH source_queue -> internal_queue
[Send] LPUSH message -> destination_queue
[Acknowledge] RPOP message <- internal_queue
"""


import time
from itertools import chain
from typing import Dict, Optional
Expand Down Expand Up @@ -326,18 +336,13 @@ def _reject_message(self):
Rejecting is a no-op as the message is in the internal queue anyway.
"""

# Algorithm
# ---------
# [Receive] B RPOP LPUSH source_queue -> internal_queue
# [Send] LPUSH message -> destination_queue
# [Acknowledge] RPOP message <- internal_queue


class Pythonlist(Pipeline):
"""
This pipeline uses simple lists and is only for testing purpose.
It behaves in most ways like a normal pipeline would do,
including all encoding and decoding steps,
but works entirely without external modules and programs.
Data is saved as it comes (no conversion) and it is not blocking.
"""
Expand Down

0 comments on commit 47c7b20

Please sign in to comment.