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

Uploaded Source

Built Distribution

aioice-0.5.2-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.5.2.tar.gz
Algorithm Hash digest
SHA256 73969effc37c836984de50054c7ae71a8bca0f5f59428db7c49e0c0ebd758671
MD5 3e1c85427d0f47fe6bd86562b3518146
BLAKE2b-256 029a1b0d6f9f108fd920f8989db09893747cd9cfe4b5c47b3620c14968e5b204

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7538f968e92945a5d2d49838752f2ddc014035b47f5a45e5a64ff48c03bae71d
MD5 781ced72c6d4f5891ccdc2cb785782b8
BLAKE2b-256 76cefc4e76cf66a2307a7c7fb29489717a9e4535b7a871876d21ad80f97f01ff

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