AsyncAPY - Official Documentation

AsyncAPY is a fully fledged framework to easily deploy asynchronous API endpoints over a custom-made protocol (AsyncAProto)

It deals with all the low level I/O stuff, error handling and async calls, exposing a high-level and easy-to-use API designed with simplicity in mind.

Some of its features include:

• Fully asynchronous
• Automatic timeout and error handling
• Custom application layer protocol
• Groups: multiple functions can handle the same packet and interact with the remote client
• Powerful, easy-to-use and high level API for clients, packets and sessions
• Packets filtering

What’s new in AsyncAPY 0.4

• Groups and handlers have been completely reworked, check the docs
• The AsyncAPY class has been renamed to Server and some breaking changes have been done
• The V1 protocol has been deprecated
• The AsyncAPY.objects module has been made private. Client and Packet objects can be imported from the top-level package
• The code for the server has been polished and improved

• AsyncAPY package
  • Submodules
  • AsyncAPY.core module
  • AsyncAPY.defaultclient module
  • AsyncAPY.errors module
  • AsyncAPY.filters module
  • AsyncAPY.server module
  • AsyncAPY.util module
  • Module contents
• AsyncAPY - Getting started
  • Installing
  • Hello, world!
  • Filters
  • Using the decorators
  • Groups
• AsyncAPY - Frequently Asked Questions
  • My console output is not ordered, why?
  • Why don’t my filter pass?
  • The encoding of the responses is wrong!
  • What the hell is ZiProto?
• AsyncAPY - Code Examples
  • Filters Examples
  • Groups Examples
• AsyncAPY - The Protocol
  • The protocol - Why not HTTP?
  • The protocol - A simple header system
  • The protocol - Supported encodings
  • The protocol - Warnings

Indices and tables

• Index
• Module Index
• Search Page