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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.8.tar.gz
  • Upload date:
  • Size: 31.1 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.8.tar.gz
Algorithm Hash digest
SHA256 6ca75c7be9043e2cc3809ff8ac8293c5049aa3a4d621f28b6abe1c9b8f33d1cc
MD5 f61e76ffb1738249ae8ab197445c000d
BLAKE2b-256 62a365dc4828f112852dc5c48549c2d803832cb8c19aafbf974e7867907a7759

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.8-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.25.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8fb1be82011b955dbb68fdbffa7d675f5898bb71769f8e051b8e21b4211ac7d8
MD5 e19eaaecea4e5912a0ca9135bf5b2dd0
BLAKE2b-256 34914e6bcfedd65c4b992b79d593f226b2434146f0fc3a8ad0205eedfa8ce011

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