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
    local_candidates = await connection.get_local_candidates()

    # send your information to the remote party using your signaling method
    send_local_info(
        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.3.3.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

aioice-0.3.3-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.3.3.tar.gz
Algorithm Hash digest
SHA256 642f4676e736cf20c70f9062535e72240843555bc0f59271ff9978becdefef9d
MD5 a932b4195282c75900c7525ca5d33c2f
BLAKE2b-256 2686321355077d094a0c9d2247718fd902973d3f6be64c43d59dc4b78ef060fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1bf7e27901c57042cb50eb59b17ef67870743bdb404efdbb27fcb654314a6975
MD5 67551415d2c41c368dfff6ab75ae9e5e
BLAKE2b-256 13c8663d603b6a196bb9c48cd18bc7d1d7cb3b39ba9b9cb92dfe7e84e4d17996

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