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

Uploaded Source

Built Distribution

aioice-0.6.13-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.13.tar.gz
Algorithm Hash digest
SHA256 e818dec282ef5eecbfbdfc8fca610cb9c0fe314fb7f8e0ca46e14a90efb46065
MD5 14096e0fc393e884fb625c61d1ad1763
BLAKE2b-256 e3039400b7439f485d12db582e6a9619cca1d3e1370327326d6b97dafd021133

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.13-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.13-py3-none-any.whl
Algorithm Hash digest
SHA256 ca53a12e33b89c627c25122682305ea03efb96126763ecc2fbf090186e3d2c82
MD5 4eb9390e01804f52cee859e8de592c39
BLAKE2b-256 31dcf0b82d6cfd11ad8554a7c968c4d9829e9d258e2f0849be52a0cee8436763

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