Skip to main content

An implementation of Interactive Connectivity Establishment (RFC 5245)

Project description

rtd pypi-v pypi-pyversions pypi-l pypi-wheel tests codecov

What is aioice?

aioice is a library for Interactive Connectivity Establishment (RFC 5245) in Python. It is built on top of asyncio, Python’s standard asynchronous I/O framework.

Interactive Connectivity Establishment (ICE) is useful for applications that establish peer-to-peer UDP data streams, as it facilitates NAT traversal. Typical usecases include SIP and WebRTC.

To learn more about aioice please read the documentation.

Example

#!/usr/bin/env python

import asyncio
import aioice

async def connect_using_ice():
    connection = aioice.Connection(ice_controlling=True)

    # gather local candidates
    await connection.gather_candidates()

    # send your information to the remote party using your signaling method
    send_local_info(
        connection.local_candidates,
        connection.local_username,
        connection.local_password)

    # receive remote information using your signaling method
    remote_candidates, remote_username, remote_password = get_remote_info()

    # perform ICE handshake
    for candidate in remote_candidates:
        await connection.add_remote_candidate(candidate)
    await connection.add_remote_candidate(None)
    connection.remote_username = remote_username
    connection.remote_password = remote_password
    await connection.connect()

    # send and receive data
    await connection.sendto(b'1234', 1)
    data, component = await connection.recvfrom()

    # close connection
    await connection.close()

asyncio.get_event_loop().run_until_complete(connect_using_ice())

License

aioice is released under the BSD license.

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

aioice-0.7.6.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

aioice-0.7.6-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file aioice-0.7.6.tar.gz.

File metadata

  • Download URL: aioice-0.7.6.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for aioice-0.7.6.tar.gz
Algorithm Hash digest
SHA256 1b906e309978c10f58bc85a72f7cd2835cf2127d7551c6c060dae2efec73e1c4
MD5 e70e17c08c23b06e2b470b3f80af68e4
BLAKE2b-256 2efa08cd290724dd5b892fabc81684910b0f3f4c14d6abd80b24f248cfc7efdb

See more details on using hashes here.

File details

Details for the file aioice-0.7.6-py3-none-any.whl.

File metadata

  • Download URL: aioice-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for aioice-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 016b7b1cd15d2af64703ebb5d484e3ee471d2f7309e6e54417e73c3b7148fcfe
MD5 6357c1478a8af9b11c6680016e1eb77c
BLAKE2b-256 f0ee739a88e3ac67cf4ca158ded47129bb9adfaf43e787a1a27525a37e86729c

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