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

Uploaded Source

Built Distribution

aioice-0.6.1-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.1.tar.gz
Algorithm Hash digest
SHA256 177041f0780b405fa495e7e45d6e6f29d5822a13ccc663371b69bfc1c6ad6818
MD5 ff57d7ad6b8fa229f9f64ceb610cc95e
BLAKE2b-256 380ce4f4b2e7326fb361d132dddf38a9192be420a2df557a65161a641d20dd6b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 91b16950dc8980b31e26494eede957b0d7b050322480692ee002bf809b67c4c9
MD5 58c23e1a7672f25549f6dc06a9330c0b
BLAKE2b-256 7ef205708d39600d8a351f8a2ba13ce86e34360f19d5e079fe4e8900a64790e3

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