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

Uploaded Source

Built Distribution

aioice-0.6.15-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.15.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/38.2.4 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.3

File hashes

Hashes for aioice-0.6.15.tar.gz
Algorithm Hash digest
SHA256 120a5938978432121c73f964c763cfcbe93a3176212c2c5ac243a0bab44a8f84
MD5 a720213374860b70d780b07bb380569c
BLAKE2b-256 12af06f33db33abdfc33f601998f6e9f02f857c402fed6daec2ec6b5c30d82b0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.15-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/38.2.4 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.3

File hashes

Hashes for aioice-0.6.15-py3-none-any.whl
Algorithm Hash digest
SHA256 b43a08c3d8e7ac8afd9a0daa89d2d4be49fd084874223af7168b78516a98c8cb
MD5 c35be9226a6cbabba891d1d90efe0555
BLAKE2b-256 62cba12c5210deedc731433fa7bed965e3fb04bac26dc69dd96e44630d19b06e

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