Skip to main content

An implementation of Interactive Connectivity Establishment (RFC 5245)

Project description

rtd pypi-v pypi-pyversions pypi-l pypi-wheel travis 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
    connection.remote_candidates = remote_candidates
    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.6.14.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

aioice-0.6.14-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.14.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/38.2.4 requests-toolbelt/0.9.0 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.14.tar.gz
Algorithm Hash digest
SHA256 a307122621908aa6c544fc86b23a50b7e17211ffa1dd4efaf3d137c68532ef97
MD5 469fc461017a7159dec29ce8503a0172
BLAKE2b-256 24ad921445e25ffe00c2cc79bc1c002373660b0ace2c924be05e76fe5ae273a6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.14-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/38.2.4 requests-toolbelt/0.9.0 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5015e486b104db5974d61309925827bc6172ae7da7c2ccaa5ac0808efc64e330
MD5 3e5a47e1eda1b3afd392efe5fcc3259d
BLAKE2b-256 03daf8f8464d12871bdf7ae4de4387a53c47802ea47a8c292e570d5daded31a9

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