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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.4.3.tar.gz
Algorithm Hash digest
SHA256 c58b98bd5dbf13b41b9c93552cdcaa72c51b8421e5f9ce6fd352c00f63e62213
MD5 6af4f79c38c71426b10dca33a622ef4e
BLAKE2b-256 a36118a428f877446a47dedba2c7c6e8dc93eedc7c708683a9e5eca24a99b369

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7e5915538ad2e4a1af2240a5b3a306c4e77a278e442e3d039f3f3588cb62295d
MD5 48a925c0423bb32a78963c0de2c7ea5d
BLAKE2b-256 cdfe593cf599effbece47f3c75f93d49681ce61dc2d9a87a04cc7f19266b01ef

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