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

Uploaded Source

Built Distribution

aioice-0.6.16-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.16.tar.gz
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.1

File hashes

Hashes for aioice-0.6.16.tar.gz
Algorithm Hash digest
SHA256 b1e136dde09e09b5ad77aff9a3e9ab51c13f4b32e11a4554895614c2a3ce4132
MD5 f5ad68311448fc1c651a14d72804f3a5
BLAKE2b-256 f442af01d6c2a190f5115e1b1d0a51fc0ebaf53c3f7c638adbe2a6fe4888d946

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.16-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.1

File hashes

Hashes for aioice-0.6.16-py3-none-any.whl
Algorithm Hash digest
SHA256 ee7202387f08ea0323f6cfdaa54dd43dc473820d08c0e5dca0afa5faa777bb91
MD5 d8c8af14175cb06caaf105b74ca18cdb
BLAKE2b-256 fc74c78795218e76e50ef0acddd7b2813e705dfca21f60158580e79348ad1d64

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