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

Uploaded Source

Built Distribution

aioice-0.6.2-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.6.2.tar.gz
Algorithm Hash digest
SHA256 c06e218fa1a2b346ddea0089544d950a79ce6f2c9757cabc8d548eb3252072d9
MD5 bf3b94dc1e9e5753c179c293e1d584e5
BLAKE2b-256 1a97e936e88d1ad622122f584393d478866e850cec9840a786d8681be64aecf6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f3623f2e6ba00aa2d41aefe4a7a5f7b8d5e6884a20c2e2a5b013f8164913126b
MD5 43701f17837264c212036df8077adbd4
BLAKE2b-256 b6325224db40eb667757da4344a32a743dd3d0917cf23eb60ed1eb58edd256fd

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