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

Uploaded Source

Built Distribution

aioice-0.6.3-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.3.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for aioice-0.6.3.tar.gz
Algorithm Hash digest
SHA256 fba64a0b3f6bf697f013e3be46c522755f56d7543d295ef2cdb4827e71841ac6
MD5 e53bb3fdb79d54f8145e8ff2dc2347f9
BLAKE2b-256 5223a3bcb38ccb61b4bbcf25b7ddf5d4bc9f9d34a1c2d31624e3778e308bc273

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 63762f6f27f786976757819c07b29fd4674cd195332f4bde4a8ad3a6d69d910d
MD5 bb4348bf2d3d67d92c04d866bbd969a6
BLAKE2b-256 243f7002869d10a8365df6df02014f03474591217b03f559eec05c75da7c5e49

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