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

Uploaded Source

Built Distribution

aioice-0.6.17-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.17.tar.gz
  • Upload date:
  • Size: 33.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.1

File hashes

Hashes for aioice-0.6.17.tar.gz
Algorithm Hash digest
SHA256 58b3bcfb09206fc2322597736da443cf795a563bc36ee9098c4816094fc39477
MD5 f41b348fab38bdd76003f8fce176d257
BLAKE2b-256 cb58cc0d050ee4a1c590fe386a61072e9c9b616341a44730ac20f99e857631c1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.17-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.1

File hashes

Hashes for aioice-0.6.17-py3-none-any.whl
Algorithm Hash digest
SHA256 f06b71dd38a64c5afc0a3be3b6c1d96f8fd31919d1ac7aa8b816fd5862d42146
MD5 d8d4377990cbee70f9e0d87185f850d7
BLAKE2b-256 d6c72d0427c46fd37b38d85324fd25aa4a5a4ed8e1a2945b41b928ed87ed0218

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