SDK Reference
API reference for the Tricryption Engine SDK — three client tiers, one key server.
| Tier | Use it when | Shape |
|---|---|---|
| C/C++ | The application links the native library. | Generated, complete class graph. |
| Java | The application runs on the JVM. | Generated, grouped by package. |
| TypeScript agent | The integration is a Node service. | Hand-written; the behaviors that mislead. |
New to the SDK? Start with the Programming Guide: the concepts every tier shares, then one page per tier — connecting, authenticating (Kerberos included), FIPS mode, deriving keys and the PISOFTJCE post-quantum provider — generated from the same engine source as the reference.
Applications that would rather speak HTTP than link anything should use the REST Gateway, which is built on the TypeScript agent.
Programming Guide
The engine's own programming guide, authored beside the headers it explains:
It covers the concepts and architecture of a deployment, then the C, C++, Java and TypeScript agents in turn. Names in the C and C++ pages link straight to their reference pages.
C/C++ API
The complete C/C++ reference — every public class in the connected graph — is available as native, fully themed documentation:
The reference is generated from the 8.1 engine source into native Docusaurus pages: it shares this site's navigation, sidebar, search, and Pi Soft theme, and every class cross-links to the others.
Java API
The complete Java reference for the TEAdmin client and admin API —
tech.pisoft.teagent (including the JAAS auth.login and event subpackages)
and tech.pisoft.teadmin:
Generated by the same pipeline as the C/C++ tier, so it shares this site's navigation, sidebar, search, and Pi Soft theme. Classes are grouped by package, and every type cross-links to the others.
Types that carry worked examples link to them directly, and the samples are
browsable on their own under Examples — the same sources that ship in the
SDK's samples/java tree.
TypeScript Agent SDK
The TypeScript agent is a Node.js client that speaks the 8.1 key server binary wire protocol directly — SRP-6a/SHA-384 login over TLS 1.3, no native build and no native dependency:
Unlike the two tiers above, this one is hand-written and deliberately small. It documents the behaviors that contradict an integrator's reasonable first reading — starting with the fact that a connection carries exactly one operation at a time, so a Promise-returning client that looks safe to drive concurrently is not.
Start at the connection model; the page explains why this tier is written by hand rather than generated.