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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.4.0.tar.gz
Algorithm Hash digest
SHA256 dd90edc497373a6d9312ed6a7abd05f2535e1e87642a8165dc166648990442d3
MD5 8a045064d9cffbbc7874250e08599545
BLAKE2b-256 34c7fe9a907ebfa8a8d01da48a5a334f8ecc70cb45e913f46f29ed33cd0838ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bfebd9079dbcfd685d072ca549f4751f5f380d62a6abfa415a6df803c503648
MD5 69936f308455bb37af41f33e51513e99
BLAKE2b-256 49a6d663b2163f92aaf40f105e656f88ffd5ef86bf3c8f5e9e9a297940950181

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