Skip to main content

An implementation of Interactive Connectivity Establishment (RFC 5245)

Project description

rtd pypi-v pypi-pyversions pypi-l pypi-wheel travis coveralls

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.7.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.7.tar.gz
Algorithm Hash digest
SHA256 1086a379f022240bfd7780a2e8734819d015c436f2aeb6182a877b9b4b9d861f
MD5 3399ce33199ec9a709ecbd0e158f2716
BLAKE2b-256 f0450cee0f5dd2ac15aeff416c1656a55b253f3cfd352c4d17f48cec8e8a0cca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.7-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 affb02037cf70fe143c0cd513728949f6c2500ba0113fef27f2985ec5926906b
MD5 4afdbc0f186ba5e42d47fd4fc1e645a5
BLAKE2b-256 604b8c6b9200afbe88c78f5b17de02381acef9182b083407778b559a0492aaa8

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