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

Uploaded Source

Built Distribution

aioice-0.5.1-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.5.1.tar.gz
Algorithm Hash digest
SHA256 541d019c6d0bbdfa3d1a84d706bbf428b6f75c1356961abd0972f3f40e2e889a
MD5 1e2e0f4616c92f2a7e2f88fc3dab563c
BLAKE2b-256 d7b5b69c4c2d3a4ab762c5b4a15f6b2294c1b024a10972c793b1c911688594e6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c9c589f0e9f977e654bf6b31df82a8f8bbc49a6c4a1fabcaa1614a22df0728cb
MD5 c50d0bf3fc94b0c4a7306fd0c1402180
BLAKE2b-256 4565667e32cdf17f72fab4155fdd5e5bf509c35b935d05bde385f4c6d251167d

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