Skip to main content

AsyncActor is an async Python module that aids in service discovery and “somewhat-leader” election in a heterogenous, sometimes-disconnected network.

AsyncActor can run on top of any reliable broadcast channel. This version includes back-ends for Serf and MQTT.

AsyncActor sends as few packets as possible, thus is well-suited for IoT-related applications with many stations but limited bandwidth.

Theory of operation

Assume that you have a non-lossy network with a bounded latency (let’s assume one second). Assume further that you’d like to know within ten seconds whether your node is still online.

AsyncActor sends one beacon message every seven to nine seconds. The message includes a list of N previous hosts that have transmitted the beacon; the host that’s last in this list will be the next transmitter.

The time slot starting at the seven-second mark is used for random hosts which would like to enter the beacon sending business. This is somewhat likely if the list of hosts is currently smaller than N. The slot at eight seconds is used for the hosts at the end of the list; the last host will send first, but if its beacon is not seen then the next-to-last will send its message, and so on.

The time slot at nine seconds is used for last-resort messages, i.e. any participating host can and will send its beacon message.

Collisions are resolved at the ten-second mark, i.e. the list of messages is ordered deterministically: the winner will announce to its clients that a new slot has started and whether all N host slots are filled.

It uses anyio <https://github.com/agronholm/anyio> as its underlying async framework.

PyPI latest version badge Code coverage badge

Installation

AsyncActor requires a back-end, i.e. either a running Serf agent or a MQTT broker.

To install AsyncActor, run the following command:

$ pip install asyncactor

or alternatively (you really should be using pip though):

$ easy_install asyncactor

or from source:

$ python setup.py install

Getting Started

These examples require a running async loop. Trio <https://github.com/python-trio/trio> is recommended, though asyncio works too.

from asyncactor import client as actor
from somewhere import some_transport

async with some_transport.connect('localhost') as t:
    async with actor(t, prefix=('actor','test')) as client:
        async for client.events as m:
            print(m)

Development

You can run the tests using the following commands:

$ serf agent & # start serf agent
$ mosquitto
$ python3 -mpytest tests

Release files for asyncactor 0.28.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for asyncactor 0.28.5
File Size Uploaded
asyncactor-0.28.5.tar.gz 33.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for asyncactor 0.28.5
File Interpreter ABI Platform
asyncactor-0.28.5-py3-none-any.whl Python 3 none any Details

Total release size: 54.9 kB

Release files / asyncactor-0.28.5.tar.gz

Download URL asyncactor-0.28.5.tar.gz
Size 33.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0277df1d7b9ebc50d8673996a0c065d610f2d404bac3414a942593591f2d3e15
BLAKE2b-256 checksum
How to use checksums
330141b460fb0f7afc4fb63f3a436090c1c2af33d6b1f69677ae81e8f64aa85f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / asyncactor-0.28.5-py3-none-any.whl

Download URL asyncactor-0.28.5-py3-none-any.whl
Size 21.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
338c02a667c6cf1239397218601dc691ff67d883a5bed7f0e38871b8a3c3e9dd
BLAKE2b-256 checksum
How to use checksums
6ec26a3d2f6e9c2ad39eacca6284b231a94c88ac49a26a55e5b97804a93d4785
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

0.28.5 This release

2 release files

0.28.4

2 release files

0.28.2

2 release files

0.27.0

2 release files

0.26.2

2 release files

0.26.1

2 release files

0.26.0

2 release files

0.25.3

2 release files

0.25.2

2 release files

0.25.1

2 release files

0.25.0

2 release files

0.24.0

2 release files

0.23.1

2 release files

0.23.0

1 release file

0.22.1

1 release file

0.20.8

1 release file

0.20.7

1 release file

0.20.6

1 release file

0.20.5

1 release file

0.17.1

1 release file

0.17.0

1 release file

0.16.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page