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.

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

Uploaded Source

Built Distribution

aioice-0.3.2-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.3.2.tar.gz
Algorithm Hash digest
SHA256 85b2e788f5f139134ecf7680298b79180ffab833c5594e67fcfce44ad61cd02d
MD5 0a9182be914fe64b87a5b5834992d3de
BLAKE2b-256 45d0283a1f8f7f0821010bbd8171e23436b9fac4dbfd815b9c0a291469a1582c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3955be1aafb8543f58777955de358ebecae74314799403538baa9692d7dc8c63
MD5 bd29871e49c37a1edb237f3c8efc3563
BLAKE2b-256 f54e63821c74d8e60e1e22d2713f4ef50d9619f24433a4ff5be7a344704886b5

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