Fuxedo logotpsvrinit()

server boot hook

Synopsis

#include <atmi.h>

int tpsvrinit(int argc, char **argv);

Description

tpsvrinit() is the server boot hook, called by the server main after the attach and before any request is read. It advertises the services the server implements (with tpadvertise()), opens application resources, and returns 0 to accept work or -1 to abort the boot. Servers built with buildserver() get a default tpsvrinit that advertises the -s names from CLOPT; write your own the moment you need runtime decisions.

Arguments

ArgumentDescription
argc, argvThe server command line: CLOPT arguments and any application-specific options.

Errors (tperrno)

CodeDescription
TPESYSTEM, TPEOSAdvertising or resource setup failed inside the hook.

Notes

Returning -1 makes the server exit and, with RESTART=Y, the bulletin board reincarnates it per MAXGEN, so a persistent boot failure shows up as repeated shutdown/restart cycles in the log.

Example

Full source: docs/api/examples/advsvr.c (build and run with make -C docs/api/examples check TUXDIR=<install>); the lines documenting tpsvrinit() are highlighted.

// Server lifecycle examples: tpsvrinit/tpsvrdone, the per-dispatch
// thread pair, runtime advertising, and tpreturn. Booted without -s
// advertisements; everything is advertised from tpsvrinit().

#include <stdio.h>
#include <string.h>
#include <atmi.h>
#include <userlog.h>

void GREET(TPSVCINFO *svcinfo) {
  // tpreturn ends the call: TPSUCCESS delivers data as the reply,
  // TPFAIL reports an application failure (tpurcode carries rcode),
  // TPEXIT ends the call and takes the server down
  tpreturn(TPSUCCESS, 0, svcinfo->data, 0, 0);
}

int tpsvrthrinit(int argc, char **argv) {
  // called once per dispatch thread, before it takes requests
  return 0;
}

void tpsvrthrdone() {
  // called when a dispatch thread exits
}

int tpsvrinit(int argc, char **argv) {
  // called once at boot, before the server takes requests: advertise
  // the services this server implements. Functions must be declared at
  // buildserver time; runtime advertising binds names to them
  if (tpadvertise((char *)"GREETX", GREET) == -1) {
    return -1;
  }
  // tpadvertisex (re)binds a name to a function with extended
  // placement flags (0 = plain); here it takes over the buildserver
  // -s advertisement of GREET
  if (tpadvertisex((char *)"GREET", GREET, 0) == -1) {
    return -1;
  }
  return 0;
}

void tpsvrdone() {
  // called once at orderly shutdown; withdraw the extra advertisement
  tpunadvertise((char *)"GREETX");
  userlog("advsvr done");
}

See also: tpadvertise, tpsvrdone, tpreturn.

fuxedo: supported. Cross-checked against Oracle Tuxedo 12.2.2 and 22.1 with the API hardening suite.