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

Uploaded Source

Built Distribution

aioice-0.4.5-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.4.5.tar.gz
Algorithm Hash digest
SHA256 612d8a837042f0da35a8b13b07cd93059e59853a38dea1f3ffc81fa020fdee13
MD5 6c290098eaa5f82bd24a344047241c06
BLAKE2b-256 49c7e28d26e6388c398253fe052808b91fa262677fec23fc31991750c062f7d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 124d50c2a5b6868fb2b8044b68767559d019718305cc812356b1968b2151776d
MD5 e8afb51843f5d872bbb0684ae58391de
BLAKE2b-256 e62d574b8b06cd90c553bb8e280939cc52f288456650f5d41bf05180ee2dc5c7

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