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

Uploaded Source

Built Distribution

aioice-0.6.6-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.6.tar.gz
  • Upload date:
  • Size: 30.4 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.24.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.6.tar.gz
Algorithm Hash digest
SHA256 005f5d7de94ed528b5e616f3401ee3aa0b63a912aacc144814c0170d8b73dd19
MD5 377d78ca4c9972cd56d285d347005315
BLAKE2b-256 3802bd0f8aad449e25e360f084bec1cb5ba46ee1d806a2efffdc3cfe03cf4596

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.6-py3-none-any.whl
  • Upload date:
  • Size: 19.1 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.24.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 02c08350fc22addbae2c68a888485b7827a3c961eea3d928378529da7b218661
MD5 6c173d635238e411fdb58d946d70e392
BLAKE2b-256 a55658e1f62fab4efd497f7be78b1f5fdfc5fc012d815e7f2353484cbf6ddeed

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