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

Uploaded Source

Built Distribution

aioice-0.4.2-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.4.2.tar.gz
Algorithm Hash digest
SHA256 55b1324a8225975f3a005da36ed59448d031274b23e2eddffbb33efb63cbb234
MD5 2322a652071f283ca8ad541694de759d
BLAKE2b-256 680d327bb59f405fa818dc41afb04daa2ebbeb054508094a37dc632929fe79e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d554d9d2bf1743fa101cd6f01a49c5d681b97b054ccd58d9815aebc129a5f6b0
MD5 2c29f395600bbaa07c91e5f75c598684
BLAKE2b-256 83b4dd3a7972971babdd988cd7ebcc401bc81a200d41488eddc7059820a4d7e6

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