Vortex Library documentation

Vortex library documentation is composed by the API reference, manuals and tutorials. They are developed and maintained using doxygen tool.

If you find something not properly documented or missing or you think you could improve some section, contact us at the mailing list. It is really important to us to keep an useful, error free, and updated documentation.

Vortex Documentation Center 1.1 (stable)

PyVortex Documentation Center 1.1 (stable)

Vortex Documentation Center 1.0 (old stable)

Products using Vortex Library

Products, applications and network protocol implementations using Vortex Library:

• Turbulence: General purpose, extensible BEEP application server.
• Shaper: Creates xml documents by integrating data resulting from XML-RPC service execution.
• jsVortex: A javascript BEEP implementation. jsVortex is using Vortex Library to validate its BEEP implementation.
• BeepFp: BEEP services for Free Pascal (binding component written on top of Vortex Library 1.1).
• PyVortex: Python bindings for Vortex Library 1.1. Official component included into base Vortex Library source code.
• Af-Arch: An Open Source N-Tier development framework.

Change notifications

The following are the set of change notifications done and the release associated where the change was implemented/introduced:

• vortex-profile-filter-01
• vortex-notify-start-01
• vortex-voidptr-update-01
• vortex-xml-rpc-gen-dispatch-01
• vortex-axllist-api-01
• vortex-async-queue-api-01

Links to BEEP related articles

• XML Watch: Bird's-eye BEEP
• An Overview of BEEP
• BEEP tiny fragment (BTF): problem description and how to fix it
• Understanding SEQ frames
• XML-RPC: building fast, prototyping better
• BNRA: BEEP no reply attack description

Links to BEEP standard and on going drafts

• RFC 3080: The BEEP Core Protocol
• RFC 3081: Mapping BEEP onto TCP/IP
• RFC 3340: The APEX protocol
• RFC 3529: The XML-RPC over BEEP profile
• RFC 3620: The TUNNEL profile
• RFC 3767: The SACRED protocol