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

Uploaded Source

Built Distribution

aioice-0.7.5-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.7.5.tar.gz
  • Upload date:
  • Size: 37.9 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.5.tar.gz
Algorithm Hash digest
SHA256 04b622b62eecc9b5c16ae5040d236b5f34422728ea5ea6f5550bfdf7b0ffef6f
MD5 498043d6f352d5c99fc09140ac009fb2
BLAKE2b-256 de8a48d4494f63e0033f470e37259f731339d555b5b439b572ade9228ec913f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 23.1 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 be3d11c93687e9ee3ce96d619d7f67f1f82ce12e9df4aa3c53b95f0546008358
MD5 9e0b03872b118ae02984dbfb6f92bf69
BLAKE2b-256 5a3231ec785c02ac848aa4a8503b86afe63e94c6bffd0d53a758a11f1e58224b

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