Skip to main content

An implementation of Interactive Connectivity Establishment (RFC 5245)

Project description

rtd pypi-v pypi-pyversions pypi-l pypi-wheel travis coveralls

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

Uploaded Source

Built Distribution

aioice-0.6.5-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.5.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.5.tar.gz
Algorithm Hash digest
SHA256 6080c4351f30318cc41b19f7490e496cd3fa651443862f0c8836a514a76a1e40
MD5 29d3ceb2eff19415e42db06af6d5f4b6
BLAKE2b-256 0172269033fa146cb41e756a51f18e705a11ce50f99badc87c8df7f051be0f4c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ef8c2f36b67d0b20709ffda225761f4811549295c4be6ea2c03ab4f8c63f5f2f
MD5 cd5b601e7ea57b6e2bbed5fd8e182d36
BLAKE2b-256 db4cf3d33945df5ce3401ca4b74d4403ebfaed30eaecf3b0e701a66db4d24263

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