Open a section from the left

Overview

This is the call guide. The project introduction is README.md in the repository root.

Include one header:


#include "pitlane/pitlane.hpp"

Everything is in the namespace pitlane. Link libpitlane.a, or link the shared library with -lpitlane. The shared library's soname is libpitlane.so.1. The headers are the same for both.

The release is kVersion, currently 2.23.0, also split into kVersionMajor, kVersionMinor, and kVersionPatch. kDeskVersion is the desk mapping-file layout and is currently 5. kYardVersion is the separate symbol/quote yard layout and is currently 2. A new library release can leave either layout number where it is.

A browsable static site with a left-hand section list is generated into doc/site/en/ (python3 doc/gen_site.py). Open a local doc/site/en/index.html or the GitHub Pages deployment — viewing the file on github.com/.../blob/... shows source only. Startup settings are covered under Startup configuration.

Headers live under pitlane/desk/, pitlane/book/, pitlane/order/, pitlane/time/, pitlane/study/, pitlane/net/, pitlane/util/, and pitlane/host/. version.hpp stays beside pitlane.hpp. The table below names the area in the path.

Prices and quantities are integers. Timestamps are microseconds. A side value of 1 buys and 2 sells. Most calls report failure by a false, a negative count, or a Why other than Why::None. They do not throw for ordinary rejects. A full ring or a full queue fails the write and leaves the previous contents in place.