https://github.com/aiortc/aioice

asyncio-based Interactive Connectivity Establishment (RFC 5245)
https://github.com/aiortc/aioice

asyncio network python rfc-5245

Last synced: 4 days ago
JSON representation

asyncio-based Interactive Connectivity Establishment (RFC 5245)

• Host: GitHub
• URL: https://github.com/aiortc/aioice
• Owner: aiortc
• License: bsd-3-clause
• Created: 2018-02-03T15:12:58.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-07-04T09:36:30.000Z (7 months ago)
• Last Synced: 2025-01-12T04:33:55.801Z (11 days ago)
• Topics: asyncio, network, python, rfc-5245
• Language: Python
• Homepage:
• Size: 320 KB
• Stars: 108
• Watchers: 7
• Forks: 52
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
aioice

======

|rtd| |pypi-v| |pypi-pyversions| |pypi-l| |pypi-wheel| |tests| |codecov|

.. |rtd| image:: https://readthedocs.org/projects/aioice/badge/?version=latest

   :target: https://aioice.readthedocs.io/

.. |pypi-v| image:: https://img.shields.io/pypi/v/aioice.svg

    :target: https://pypi.python.org/pypi/aioice

.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/aioice.svg

    :target: https://pypi.python.org/pypi/aioice

.. |pypi-l| image:: https://img.shields.io/pypi/l/aioice.svg

    :target: https://pypi.python.org/pypi/aioice

.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/aioice.svg

    :target: https://pypi.python.org/pypi/aioice

.. |tests| image:: https://github.com/aiortc/aioice/workflows/tests/badge.svg

    :target: https://github.com/aiortc/aioice/actions

.. |codecov| image:: https://img.shields.io/codecov/c/github/aiortc/aioice.svg

    :target: https://codecov.io/gh/aiortc/aioice

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`_.

.. _read the documentation: https://aioice.readthedocs.io/en/stable/

Example

-------

.. code:: python

    #!/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

        for candidate in remote_candidates:

            await connection.add_remote_candidate(candidate)

        await connection.add_remote_candidate(None)

        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`_.

.. _BSD license: https://aioice.readthedocs.io/en/stable/license.html