Documentation

Aionetiface is a networking library for >= Python 3.5 that supports multi-interface networking. It includes back-ported patches from recent Python versions to make asyncio work better on older versions as well as new features that aren’t possible with asyncio today. EG:

nic = await Interface("eth0")

You can use aionetiface to write software that works across multiple networks (like VPNs, proxies, file software, servers, etc.) The software has many interesting features that set it apart from other libraries like being able to correctly identify external addressing information and making that easy to use.

# Bind to the first external IPv6 available
route = nic.rp[IP6][0]
pipe = await Pipe(TCP, ("example.com", 80), route).connect()

Above, shows an example of a unified interface for both client and server code based around the idea of “pipes.” Programming can be done in a similar way to Python’s regular protocol classes (callback style) or awaiting the pipe directly.

That’s the tip of the ice berg though – and the deeper you go – the more interesting (and maybe bizarre) things you will discover.

• General networking
  • Basic concepts
    • Protocol design
    • What about UDP?
  • Pipes
    • Interface selection
    • TCP echo server example
    • UDP await example
    • Pipe methods
      • def add_msg_cb(self, msg_cb)
      • def del_msg_cb(self, msg_cb)
      • def add_end_cb(self, end_cb)
      • def del_end_cb(self, end_cb)
      • def add_pipe(self, pipe)
      • def del_pipe(self, pipe)
      • async def close(self)
      • Additional pipe options
  • Interfaces
    • The addressing problem
    • Routes to the rescue
    • Using a route with a pipe
    • Route pools
    • Default interface
  • Queues
    • Why use message subscriptions?
    • Using queues
    • Final conclusions
  • Daemons
    • async def add_listener(self, proto, route)
    • async def listen_all(self, proto, port, nic):
    • async def listen_loopback(self, proto, port, nic):
    • async def listen_local(self, proto, port, nic):
• Knowledge articles
  • Installation
    • Installation on older systems
    • Windows Vista
    • Windows XP
  • Running examples
  • Socket close
  • Future work
    • Network changes
    • Firewall bypass
    • Pushing sockets
    • Error recovery code
    • Other ideas
• Feature showcase
  • STUN client for address lookups
    • STUN magic cookies
  • More portable netifaces
  • Hyper-usable HTTP client
  • Lightweight web framework
• Development
  • Debugging mode
  • Running tests
  • Building the docs