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.4.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

aioice-0.7.4-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.7.4.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for aioice-0.7.4.tar.gz
Algorithm Hash digest
SHA256 3b01b5df33414a14454370b3662b3d4aa8ab0fa08b7ea1117e79fc8f128b8e14
MD5 47ce596b99e32145199aed372e800027
BLAKE2b-256 acdada1f679c323bdc6d6d838dedfdfa484db631afc742eef9c55d8d9e466944

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.1

File hashes

Hashes for aioice-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a714ed0d6a0d0d65041580daee623d26b8e4de5c881913658222a135b0d71077
MD5 16d352c7d63f45eb71d63a25466d5c02
BLAKE2b-256 a070edfb1829bcd7f9b7bc3781537c6d37d8cc7e5506ce87bca5f5c1dc4257bf

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