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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.11.tar.gz
Algorithm Hash digest
SHA256 af67751e0cfeb8d58c3f2eedd6af399f8643e70b8a998de8365df1f697c65651
MD5 0e7a05dcb075f7f302dfd165fb56c929
BLAKE2b-256 63dd93d8367763f4aa19c8a1a7647e814d49aef932b6cafd253bc41c708ec921

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.11-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.21.0 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.11-py3-none-any.whl
Algorithm Hash digest
SHA256 10332c0d841d58da12a2eaffb5e28ab7e9b58ea3aa6a9f343b9c65cf19bd3457
MD5 85326ae926404d8ea6f7c3b3680d407b
BLAKE2b-256 26755cbca953135c8daca7fc5db60e006148ac7ff9242ef49e2240b6f96a17d5

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