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

#!/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
    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.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.8.0.tar.gz (40.2 kB view details)

Uploaded Source

Built Distribution

aioice-0.8.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.8.0.tar.gz
  • Upload date:
  • Size: 40.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for aioice-0.8.0.tar.gz
Algorithm Hash digest
SHA256 16fac8a5a02488ac63b46da9462546818b06f455d76c8397314fc72c5b6c0164
MD5 fd7be71256321de579cc80c36b618f74
BLAKE2b-256 43a96eb846a371953cc9075f5acf1e2d1e1ed7b601d7b248ec2662c239033f84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for aioice-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3636c234e4812a9e28dd7ab8457a6ccb4dec864cfbaa3775c2b55b902eb78699
MD5 e815054c2ac84f57252b60d1e8ad7f08
BLAKE2b-256 73409b69b89f550eea367d7386f32b00b2f91749517149e9df853843c068436d

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