Skip to main content

CometD client for asyncio

Project description

aiocometd

PyPI package Documentation Status Build status Coverage MIT license

aiocometd is a CometD client built using asyncio, implementing the Bayeux protocol.

CometD is a scalable WebSocket and HTTP based event and message routing bus. CometD makes use of WebSocket and HTTP push technologies known as Comet to provide low-latency data from the server to browsers and client applications.

Features

  • Supported transports:
    • long-polling

    • websocket

  • Automatic reconnection after network failures

  • Extensions

Usage

import asyncio

from aiocometd import Client

async def chat():
    nickname = "John"

    # connect to the server
    async with Client("http://example.com/cometd") as client:

            # subscribe to channels to receive chat messages and
            # notifications about new members
            await client.subscribe("/chat/demo")
            await client.subscribe("/members/demo")

            # send initial message
            await client.publish("/chat/demo", {
                "user": nickname,
                "membership": "join",
                "chat": nickname + " has joined"
            })
            # add the user to the chat room's members
            await client.publish("/service/members", {
                "user": nickname,
                "room": "/chat/demo"
            })

            # listen for incoming messages
            async for message in client:
                if message["channel"] == "/chat/demo":
                    data = message["data"]
                    print(f"{data['user']}: {data['chat']}")

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(chat())

For more detailed usage examples take a look at the command line chat example or for a more complex example with a GUI check out the aiocometd-chat-demo.

Documentation

https://aiocometd.readthedocs.io/

Changelog

0.4.5 (2019-03-14)

  • Fix connection issues when used with reverse proxy servers with cookie based sticky sessions

0.4.4 (2019-02-26)

  • Refactor the websocket transport implementation to use a single connection per client

0.4.3 (2019-02-12)

  • Fix reconnection issue on Salesforce Streaming API

0.4.2 (2019-01-15)

  • Fix the handling of invalid websocket transport responses

  • Fix the handling of failed subscription responses

0.4.1 (2019-01-04)

  • Add documentation links

0.4.0 (2019-01-04)

  • Add type hints

  • Add integration tests

0.3.1 (2018-06-15)

  • Fix premature request timeout issue

0.3.0 (2018-05-04)

  • Enable the usage of third party JSON libraries

  • Fix detection and recovery from network failures

0.2.3 (2018-04-24)

  • Fix RST rendering issues

0.2.2 (2018-04-24)

  • Fix documentation typos

  • Improve examples

  • Reorganise documentation

0.2.1 (2018-04-21)

  • Add PyPI badge to README

0.2.0 (2018-04-21)

  • Supported transports:
    • long-polling

    • websocket

  • Automatic reconnection after network failures

  • Extensions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiocometd_ng-0.5.6.tar.gz (56.2 kB view details)

Uploaded Source

Built Distribution

aiocometd_ng-0.5.6-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

Details for the file aiocometd_ng-0.5.6.tar.gz.

File metadata

  • Download URL: aiocometd_ng-0.5.6.tar.gz
  • Upload date:
  • Size: 56.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.2

File hashes

Hashes for aiocometd_ng-0.5.6.tar.gz
Algorithm Hash digest
SHA256 c81037f0be56944f6ce0bf693e7b830ff84cfd379a9e9e9a5614f8b9f0931252
MD5 4ba39442ca70c9a0ba1d15ee73e2c28e
BLAKE2b-256 1bb35a04b02cfa27436caf1653df42cd56a7642ce3ccc7c4e8e4e49ddd25401a

See more details on using hashes here.

File details

Details for the file aiocometd_ng-0.5.6-py3-none-any.whl.

File metadata

  • Download URL: aiocometd_ng-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 28.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.2

File hashes

Hashes for aiocometd_ng-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6d6bf7c7c1f8ec3a5a487266a1203d671b34d576157c49554186acb517c1d85b
MD5 a7b08a73c5678dedf5e32d3ccaf278b5
BLAKE2b-256 d2c97bed4c13594591ed8fdf1c928b3a9b3845b881ced0d1db8e3f2d1b964ea1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page