AsyncIO (AIO)

Table of Contents

  1. Overview
  2. Creating a Connection
  3. Starting and Stopping
  4. Sending Messages
  5. Full AIO Example
  6. Notes

Overview

The AIOHubConnectionBuilder provides an async/await compatible connection for use in asyncio-based applications. This is a minimal implementation and will be expanded in future versions.

Creating a Connection 

from signalrcore.aio.aio_hub_connection_builder import AIOHubConnectionBuilder

builder = AIOHubConnectionBuilder()\
    .with_url(server_url, options=options)\
    .configure_logging(logging.DEBUG, socket_trace=True)\
    .with_automatic_reconnect({
        "type": "raw",
        "keep_alive_interval": 10,
        "reconnect_interval": 5,
        "max_attempts": 5
    })

hub = builder.build()

Starting and Stopping 

await hub.start()

# ... use the connection ...

await hub.stop()

Sending Messages 

await hub.send("SendMessage", [username, message])

Full AIO Example 

import asyncio
import logging
from signalrcore.aio.aio_hub_connection_builder import AIOHubConnectionBuilder


async def main():
    server_url = "wss://localhost:44376/chatHub"
    options = {"verify_ssl": False}

    hub = AIOHubConnectionBuilder()\
        .with_url(server_url, options=options)\
        .configure_logging(logging.DEBUG, socket_trace=True)\
        .with_automatic_reconnect({
            "type": "raw",
            "keep_alive_interval": 10,
            "reconnect_interval": 5,
            "max_attempts": 5
        }).build()

    hub.on_open(lambda: print("Connected!"))
    hub.on_close(lambda: print("Disconnected"))
    hub.on("ReceiveMessage", print)

    await hub.start()
    await hub.send("SendMessage", ["user", "Hello from async!"])
    await hub.stop()


asyncio.run(main())

Notes

  • The AIO implementation is currently minimal. Upcoming versions will include full async transport layer support and async callbacks.
  • For authentication, pass an access_token_factory in the options dictionary.
  • The same configuration options (transport, SSL context, headers) available in the sync builder are supported.