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

Uploaded Source

Built Distribution

aioice-0.7.1-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.7.1.tar.gz
  • Upload date:
  • Size: 35.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for aioice-0.7.1.tar.gz
Algorithm Hash digest
SHA256 7dac283845089f3e6abc4269e597cfe1ac7790689174ac516f401a3430afa2bf
MD5 714755e5ae37a5b0d2e3cd4312cc312a
BLAKE2b-256 649c8e464553c2fc84019831f26f05a0bd64c820b7a309f224ec3114d46d512c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for aioice-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 db8f6d56553359976a22642a0e879fa59758fed2b2418022d3659659fd9d84ca
MD5 6256fd27442e26c9668898d032945e60
BLAKE2b-256 5f61b0bfb2f2e2fbfbc577dc95c15f06caf20653c6cdb28c41f857ab7eef8b4a

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