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

Uploaded Source

Built Distribution

aioice-0.7.2-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.7.2.tar.gz
  • Upload date:
  • Size: 37.3 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.2.tar.gz
Algorithm Hash digest
SHA256 95e9805b3d4c306f790f1c4df45720ed30d0502bbab3cd2b49000d9e8416d63a
MD5 b5ecddcc12b8cdae40de9b93743da85b
BLAKE2b-256 974054a79e0cd775a9ce5f08aa8377c7252c041a9043049195e179631c8552b3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 22.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 912c44a75f65215d28ea8d42eaf5e22a5e98f9d223c48b0a9bb76c00f971c439
MD5 bc0ed5e13b1d3873baa633a567fc57b7
BLAKE2b-256 3263afe99d46dbe9e35fde9893a61f4a91115adcdba74498e82bdb5596150935

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