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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aioice-0.4.1.tar.gz
Algorithm Hash digest
SHA256 719efbbf5f4f68834bb2add3dfded91c38996e10de4d2750a06526114bcdc8a1
MD5 d74985d16c3b12bb10bf74593bc87b13
BLAKE2b-256 e0d0652ce9be9e3b0890acb5edcac127226cd68e9814d755abc0d41ba5f0ee27

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aioice-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f26790e49e904bed20efe46e1381a16f4264dafd290b13909628c53cf4863e6e
MD5 e6eb42abd73b9e29d24f0334d792b8dc
BLAKE2b-256 bea1cdc7036246d9a0101f7e55623d5ff98a08ea41b6c6572ce504ce06f06ba1

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