Skip to main content

An implementation of Interactive Connectivity Establishment (RFC 5245)

Project description

rtd pypi-v pypi-pyversions pypi-l pypi-wheel travis codecov

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

Uploaded Source

Built Distribution

aioice-0.6.10-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioice-0.6.10.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.10.tar.gz
Algorithm Hash digest
SHA256 61bef2e1668d6269731c1de791c959a1de84fb5addf3a7978e1f3fc7c12e0358
MD5 26a4978936675ba98ce5f31dccd3f359
BLAKE2b-256 9819f9944bbbb6c743a1cc7e6700908bfd2946d80fd931953ed2f645870093b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioice-0.6.10-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/38.2.4 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.3

File hashes

Hashes for aioice-0.6.10-py3-none-any.whl
Algorithm Hash digest
SHA256 ae5254e8d62ca59ab6b6f80482174c92614148491ec1eac334d702fbabe35597
MD5 fcf9cd75e06d4cce8e19c28536696825
BLAKE2b-256 0fecc42d2814b9fe33c940b6ad28d5e8ad5f8449f5378751d93bc26ca8317b73

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