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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.12.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0 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.12.tar.gz
Algorithm Hash digest
SHA256 00f6afd92971dabe6312d7240898ee10da131a17a54b795026a467b08c02087f
MD5 ac693472a74d2c1bb144329dfe9466cc
BLAKE2b-256 394731246f28c34d2a360af6c508f1dafd67d5d7f35254337acc7e407c641c35

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.12-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.5.0 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 34a37a75057f6e8c818b3b2c37abd7bd7e8257a065774496d7316b2bb2e238a8
MD5 85e72129b4b318b1de996b4627963f27
BLAKE2b-256 4c02b137c98041d4fcd1319eda0c4fa1a0cd121dfa2fcdff573be8d7ed0452f8

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