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

Uploaded Source

Built Distribution

aioice-0.6.9-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.9.tar.gz
Algorithm Hash digest
SHA256 133da5cc7d169a5b8ac0fe9efe0262b13bf0e1b43aa68eeecb4f804c0e13d670
MD5 05541186f006947d079f8e61b6e07de6
BLAKE2b-256 7b552177ff63bdecbf63267ce6a204ee245127d29020666d3339a6b29a1f520d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0abe401953b45811cc6374a4b0ea55330a800263fa1050e32cc852390b4cf229
MD5 856800fad1c066797d0dd616c0a76c77
BLAKE2b-256 ad361310a2c41ac5ab5f8a41c64e6d1585adda57f59697eb5cc40e917d32255c

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