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

Uploaded Source

Built Distribution

aioice-0.6.4-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.4.tar.gz
Algorithm Hash digest
SHA256 463d1c3b1ab45c02d3c0406884b0b2917e0ff240a982fbb455ad14c5f888fb79
MD5 79cd4005225aee0ca6c890adb028910a
BLAKE2b-256 70fe33976aeffdffb4d13bc11c015d83a8b40ef6ab148058d169a4a78e6c01d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6458817e058a6faffaebe9576ced5ee5cf990ce4ac57b3f0dc5eb15719b45993
MD5 5c2419bb205ff1c9fce0e74479eced7d
BLAKE2b-256 0157a006fbb72ea5d3d428eb1243927c864cd8df64b09db84ba12906934a87aa

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