Skip to main content

An implementation of Interactive Connectivity Establishment (RFC 5245)

Project description

rtd pypi-v pypi-pyversions pypi-l pypi-wheel tests codecov

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

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
    for candidate in remote_candidates:
        await connection.add_remote_candidate(candidate)
    await connection.add_remote_candidate(None)
    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.run(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.10.1.tar.gz (44.3 kB view details)

Uploaded Source

Built Distribution

aioice-0.10.1-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.10.1.tar.gz
  • Upload date:
  • Size: 44.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aioice-0.10.1.tar.gz
Algorithm Hash digest
SHA256 5c8e1422103448d171925c678fb39795e5fe13d79108bebb00aa75a899c2094a
MD5 64414be299c6d11b77c7295daef335a1
BLAKE2b-256 95a245dfab1d5a7f96c48595a5770379acf406cdf02a2cd1ac1729b599322b08

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aioice-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f31ae2abc8608b1283ed5f21aebd7b6bd472b152ff9551e9b559b2d8efed79e9
MD5 e9932e4767721f39679df6e9070a47f1
BLAKE2b-256 3b58af07dda649c22a1ae954ffb7aaaf4d4a57f1bf00ebdf62307affc0b8552f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page