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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.4.4.tar.gz
Algorithm Hash digest
SHA256 504971ed591dac1f04a52b4aa6957dd1dd592c53bf7dccfd80ee5d8a5185e464
MD5 d6f35e4f14892b7d8ed980f153cbe319
BLAKE2b-256 ee5f837099ade998a2a819e6f36c2083749d8f970353edfda7efd92bb0475d37

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 51054dc62d09161b65b367f121983068e6935d9a51b9a77dc9e1c730f03f1071
MD5 58ca6541a4b308dc2b331b0e5a62bfb9
BLAKE2b-256 faec7e77d10187322791e508bda71b63f73adc6ca084e3b5740df58bd7fd9752

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