the Tuxedo C API, tersely
This is the reference for the C API shared by Oracle Tuxedo and
Fuxedo: the X/Open XATMI
calls (tp*) and the FML32 fielded buffer calls
(F*32). It is written for people who already program against
the API and want exact flags, error codes, and edge behavior without
page-filler.
Every page embeds a complete, compilable program from
docs/api/examples, with the documented call highlighted;
the whole app builds and runs with make -C docs/api/examples
check TUXDIR=<install> against either Tuxedo or Fuxedo.
Conventions:
tperrno code and the condition
that sets it. Only codes a real call can produce are listed.tperrno; the value
is meaningful only after -1. This matches Oracle Tuxedo behavior that
production code depends on.Most of the API behaves identically on Oracle Tuxedo 12.2 and 22.1. The functions below carry pinned behavioral differences; each page spells out what differs. fuxedo defaults to the 12.x behavior.
| Function | What it does |
|---|---|
| tpinit | join an application. |
| tpterm | leave an application. |
| tperrno | the ATMI error indicator. |
| tpstrerror | render a tperrno code. |
| tpcall | synchronous request/response service call. |
| tpacall | asynchronous service call (send half). |
| tpgetrply | collect the reply of an outstanding call. |
| tpcancel | abandon an outstanding call. |
| tpforward | hand the request to another service (server only). |
| tpalloc | allocate a typed buffer. |
| tpfree | release a typed buffer. |
| tptypes | inspect a typed buffer. |
| tpexport | render a typed buffer in portable form. |
| tpimport | rebuild a typed buffer from its portable form. |
| tpbegin | start a transaction. |
| tpgetlev | are we in transaction mode?. |
| tpsuspend | stash the current transaction. |
| tpresume | re-enter a stashed transaction. |
| tpcommit | commit the current transaction. |
| tpabort | roll the current transaction back. |
| tpsvrinit | server boot hook. |
| tpsvrdone | server shutdown hook. |
| tpsvrthrinit | dispatch-thread start hook. |
| tpsvrthrdone | dispatch-thread exit hook. |
| tpreturn | finish a service call (server only). |
| tpadvertise | advertise a service at runtime (server only). |
| tpadvertisex | advertise a service with placement flags. |
| tpunadvertise | withdraw a service advertisement (server only). |
| fml32 | fielded buffers: the model. |
| Ferror32 | the FML32 error indicator. |
| Fstrerror32 | render an FML32 error code. |
| Fadd32 | append a field occurrence. |
| Fchg32 | change a field occurrence (the Swiss Army knife). |
| Fget32 | read a field occurrence. |
| Fdel32 | delete field occurrences. |
| Fnext32 | iterate over all fields. |
| Fprint32 | print a buffer to stdout. |
| Ffprint32 | print a buffer to a FILE. |
| Fwrite32 | write a buffer to a FILE (binary). |
| Fread32 | read a buffer from a FILE (binary). |
| Fboolco32 | compile a boolean expression. |
| Fboolev32 | evaluate a boolean expression over a buffer. |
| Fboolpr32 | print a parsed boolean expression tree. |
| Fmkfldid32 | build a field id from a type and a number. |
| Fneeded32 | size an addition before making it. |
| Fsizeof32 | current buffer size. |
| Flen32 | stored length of one occurrence. |