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

Uploaded Source

Built Distribution

aioice-0.5.0-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.5.0.tar.gz
Algorithm Hash digest
SHA256 5c537e8e008bdcc591a4fa8774661ff0191bd838fb7476fa79c53f7f6b9d3ff6
MD5 4fd42a1d739537d4979c6a9497c84275
BLAKE2b-256 d15c982b4f925e1a44936097b2582884934714ee9bcf010c60243f9205957ab7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7582d5265b85b99a5517fbc83a43c7a4dc91f8eaf73e786473f7ba48f7574e68
MD5 b249e443f44016537546a2be3c7005e9
BLAKE2b-256 3cf5b3b5618613ee7032185b12159742b7614e063b88b37f1f29e733ac0362d8

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