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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.0.tar.gz
Algorithm Hash digest
SHA256 b0d82fb4deda8e9b834db48cc09d2d487aa8864e7c5078895b2fd82b02b993e1
MD5 54b425e5be5d41ab80486fc56380c8c9
BLAKE2b-256 65baa84956dcfc70a4b1e9d6030151040f16a8b4fd042db1b204d143e7c1a333

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f1bb631199e1530e84395aede491ef5781b6243990625a313d9f6791a349fc2
MD5 64544b41174fabf709773b598b1cad38
BLAKE2b-256 f48b811a97d21e1be01957d464e211f40dcbfcb2f18b8a8216e781467fb529a7

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