Table of Contents
This chapter presents a list and brief description of the commands and functions used in the Tmax system.
The following are commands available in Tmax.
| Command | Description |
|---|---|
| cfl | Compiles a Tmax text configuration file into a binary file. |
| etmm / eclh | Improves performance when an event-driven communication method uses more fds than an existing communication method. |
| fdlc | Compiles a field key table. |
| gst | Creates a service table by referring to a binary Tmax configuration file. |
| mkacl | Creates an access control list (ACL). |
| mkcli | Creates a Tmax client module. |
| mkgrp | Creates a user group. |
| mkpw | Manages a password file. |
| mksvr | Creates a Tmax server module. |
| racd | Centralizes the management of nodes in a distributed multi-node environment. |
| racdr | Uses the racd process running in another domain to transfer a file to a directory or to execute the tmboot, tmdown, cfl, or gst. |
| sdlc | Compiles a file that defines structures. |
| svcrpt | Analyzes and prints log records related to a service execution while a Tmax system operates. |
| tdlclean | Removes outdated library files and unnecessary files under a run directory. |
| tdlinit | Initializes TDL shared memory and dynamic modules. |
| tdlnm | Retrieves a list of functions to be automatically exported to a specified library. |
| tdlrm | Removes shared memory when a TDL is no longer used. |
| tdlshm | Retrieves information about TDL shared memory or enables/disables statistics monitoring and modules. |
| tdlsync | Synchronizes a backup file with TDL shared memory. |
| tdlupdate | Updates a specified dynamic module. |
| tencrypt | Encrypts an OPENINFO clause in a configuration file. |
| tmadmin | Manages a Tmax system. |
| tmapm | Redefines a signal alarm for a service or provides a service timeout for a service that cannot use a signal alarm. |
| tmaxlibver | Retrieves a Tmax library version. |
| tmaxtrace | Enables runtime tracing for each application. |
| tmboot | Starts an entire Tmax system or a portion of it. |
| tmd | Simulates a client for testing a server program. |
| tmdown | Terminates an entire Tmax system or a portion of it. |
| tmmbfgen | Converts a text service information file into a binary file. |
| tmsnmpd | Retrieves a Tmax configuration and performance information via the standard SNMP protocol. |
| tperr | Retrieves detailed error information using an error number and type. |
| uncfl | Converts a binary Tmax configuration file into a text Tmax configuration file. |
| untmmbfgen | Converts a binary service information file into a text file. |
| xwsdlgen | Creates a WSDL file, which defines web services. |
The following are functions available in Tmax.
| Function | Description |
|---|---|
| gettperrno | Returns errno, which is an error code set in a server and client, when calling a Tmax System. |
| tmax_chk_conn | Checks the connection status of a client by checking the execution status of a tpstart() function, socket status, and message transmission. |
| tmax_gq_count | Returns the amount of data stored in a GQ. |
| tmax_gq_get | Retrieves data from a GQ with a specified key. |
| tmax_gq_getkeylist | Retrieves a GQ key list. |
| tmax_gq_keygen | Generates a system key and retrieves it. |
| tmax_gq_purge | Removes data specified with a key from a GQ. |
| tmax_gq_put | Enters data into a GQ. |
| tmax_get_sessionid | Returns a current session ID. |
| tmax_keylist_count | Retrieves a key count from a keylist handle. |
| tmax_keylist_free | Releases memory and other resources in a keylist handle. |
| tmax_keylist_getakey | Retrieves information on a key located at the nth index in a keylist. |
| tmax_sq_count | Returns the amount of data stored in a SQ of a current session. |
| tmax_sq_get | Retrieves data from a SQ. |
| tmax_sq_getkeylist | Retrieves a key list from a current SQ. |
| tmax_sq_keygen | Creates a system key and retrieves it. |
| tmax_sq_purge | Removes data specified with a key from a SQ |
| tmax_sq_put | Enters data into a SQ |
| tmaxlastsvc | Enables a user to find a service name before service results are returned to a user. The user can use this information to find the name of a service in which an error occurred, or they can find the most recently executed routine. |
| tmaxreadenv | Reads information about an accessed system from a file and redefines environment variables. |
| tp_sleep | Waits for arrival of data in seconds. |
| tp_usleep | Waits for arrival of data in microseconds. |
| tpabort | Rolls back a global transaction. |
| tpacall | Sends an asynchronous service request. |
| tpacallsvg | Asynchronously sends a service request to a service included in a specific server group in a server group environment grouped by a COUSIN. |
| tpalivechk | Displays the connection status of a client by checking a socket status |
| tpalloc | Allocates a typed buffer. |
| tpbegin | Sets a transaction time and starts a global transaction. |
| tpbroadcast | Broadcasts unsolicited messages to clients registered to a Tmax system. |
| tpcall | Sends a service request through synchronous communication and receives a response to the request. |
| tpcallsvg | Calls service from a server group through synchronous communication in a multi server group environment grouped by COUSIN. |
| tpcancel | Cancels a call descriptor. |
| tpcommit | Commits a global transaction. |
| tpconnect | Allows a program to establish communication with a conversational service 'svc'. |
| tpdeq | Loads data from a RQ. |
| tpdeq_ctl | Supports transactions and loads data from a RQ. |
| tpdiscon | Closes a connection in a conversational communication. |
| tpenq | Stores data in a RQ. |
| tpenq_ctl | Supports transactions and stores data in a RQ. |
| tperrordetail | Extracts the depth of an error. |
| tpextsvcinfo | Provides detailed information about data derived from a RQ through a tpdep() function in a server and a client. |
| tpextsvcname | Extracts a service name from data read from a RQ. |
| tpfree | Frees memory allocated in a typed buffer. |
| tpget_timeout | Returns a configured blocking timeout. |
| tpgetactivesvr | Retrieves a list of active servers. |
| tpgetcliaddr | Retrieves the ip and port number of a client connecting to a Tmax system. |
| tpgetcliaddr_ipv6 | Retrieves the ip and port number of a client connecting to a Tmax system with the IPv6 protocol environment. |
| tpgetclid | Retrieves the ID of a client connected to a Tmax system. |
| tpgetctxt | Returns a current context. |
| tpgetenv | Returns the value of an environment parameter registered under a 'name'. |
| tpgetlev | Checks whether a transaction mode is active. |
| tpgetpeername | Returns the socket address of a peer node after a connection is established in a Tmax system. |
| tpgetrply | Receives a reply to an asynchronous service request sent through a tpacall() function. |
| tpgetsockname | Returns the name of a current socket used internally by a Tmax system. |
| tpgetsprlist | Retrieves the index of a server process to which a relevant service belongs. It is used to call a service as a server process unit. |
| tpgetsvglist | Returns information about a server group to which a service belongs or that of its cousin server group. |
| tpgprio | Retrieves the priority of a service request. |
| tpmcall | Calls the services of all server groups that belong to a COUSIN. |
| tpmcallx | API developed to support the extended features of a tpmcall(). Unlike existing functions, it waits until it receives replies from all services of a COUSIN server group. |
| tpnotify | Sends unsolicited message to a specified client from a server. |
| tppost | Posts a specific event. |
| tpputenv | Reconfigures an environment variable. |
| tpqstat | Requests statistical data stored in a RQ. |
| tpqsvcstat | Returns the statistical data of a specific service stored in a current queue. |
| tprealloc | Reallocates a pointed buffer and returns a pointer to a new buffer. |
| tprecv | Receives data transmitted from a program connected through conversational communication. |
| tpreissue | Reissues a request currently in the fail queue of a RQ. |
| tpscmt | Changes a commit configuration in a configuration file. |
| tpsend | Sends data to a peer program in an interactive communication. |
| tpsetsvctimeout | Sets the service timeout in a server. |
| tpset_timeout | Sets a block timeout. |
| tpsetfd | Registers a socket fd in a UCS process scheduler. |
| tpsleep | Sleeps for a maximum time for a timeout and returns immediately when data arrives within that time. |
| tpspracall | Calls a service for a specific server process with a certain index from the indexes obtained by a tpgetsprlist(). |
| tpsprio | Sets the priority of the next request to be sent by a tpacall(). |
| tpsetctxt | Sets a current context. |
| tpstrerror | Outputs messages related to an error code. |
| tpsubqname | Returns the name of a queue that corresponds to a sub queue number. |
| tpsubscribe | Subscribes to an event or set of events named by an eventname. |
| tptypes | Provides information about the type and subtype of a buffer. |
| tpunsubscribe | Removes an event subscription or a set of event subscriptions from the list of subscriptions of a Tmax system. |
| tuxgetenv | Returns the value of an environment parameter registered under a 'name' parameter. |
| tuxputenv | Applies 'name= value', entered as a string, to an environment variable. |
| tuxreadenv | Loads environment variables from a file. |
| tx_begin | Starts a global transaction. |
| tx_commit | Commits a transaction job. |
| tx_info | Returns global transaction information. |
| tx_rollback | Rolls back a transaction. |
| tx_set_commit_return | Sets a commit_return property. |
| tx_set_transaction_control | Sets a transaction_control property as a control value. |
| tx_set_transaction_timeout | Sets a transaction_timeout property as a timeout value. |
| ulogsync | Stores ‘ulog’ contents in the memory buffer to a <ulog.dat> file. |
| userlog | Writes information required for programs to a <ulog.date> file. |
| UserLog | Writes on a 'ulog' file immediately without using a memory buffer. |
| tpremoteconnect | Connects to a remote system with TCP. |
| tpgetrcahseqno | Returns a RCAH process number like tpgetsvrseqno API. |
| tpgetrcainfo | Returns RCAH thread information. |
| Function | Description |
|---|---|
| _tmax_check_license | Validates Anylink and OpenFrame licenses. |
| _tmax_event_handler | A callback function triggered by a SLOG in situations where a SVRTYPE is set to EVT_SVR. |
| _tmax_main | Used for a user program that contains a main. |
| tmadmin | Enables dynamic usage of statistical information, which can be retrieved through tmadmin, a system admin tool. |
| tmax_get_db_passwd | Identifies the password of a username in a database to which Tmax is currently connected. |
| tmax_get_db_tnsname | Identifies the tnsname in a database to which Tmax is currently connected. |
| tmax_get_db_usrname | Identifies the username in a database to which Tmax is currently connected. |
| tmax_get_svccnt | Returns the number of services available on a server. |
| tmax_get_svclist | Retrieves a list of services available on a server. |
| tmax_is_restarted | Displays a server restart status after a server process failure. This function can be called from a Tmax AP Server routine. |
| tmax_is_xa | Displays whether a server to which a process belongs to is XA compliant or not. |
| tmax_my_svrinfo | Displays the system configuration of a server process. |
| tmgetsmgid | Supports the SysMaster trace function and returns a group ID of a calling process. |
| tmget_smtrclog | Stores logging data in a structure buffer. |
| tmget_smtrclog_count | Returns the amount of data to be logged. |
| tpadvertise | Allows a server to advertise the service that it offers. |
| tpcancelctx | Removes the contents of a CTX_T structure in a server library. |
| tpchkclid | Checks whether a client is normally connected to a server to receive unsolicited messages before sending data used by a UCS process. |
| tpclrfd | Turns off the bit for a socket fd in an internal fdset used by a UCS-type process. |
| tpclrfd_w | Turns off the bit for a socket fd in an internal writable FDSET used by a UCS-type process. |
| tpforward | Forwards a client request to a svc service routine. |
| tpgetctx | Saves a value of a CTX_T structure in a server library to a user variable. |
| tpgetdbsessionid | Retrieves RM session information. |
| tpgetmaxsvr | Returns a maximum server process count. |
| tpgetmaxuser | Retrieves the maximum number of concurrent users of a node to which a server process belongs. |
| tpgetminsvr | Returns the minimum number of server processes. |
| tpgetmynode | Returns the name and number of a node. |
| tpgetmysvgno | Retrieves an engaged server group number. |
| tpgetmysvrid | Returns a server process ID. |
| tpgetnodename | Retrieves the node number corresponding to a nodename. |
| tpgetnodeno | Retrieves the node number corresponding to a nodename. |
| tpgetorgclh | Returns the clh number to which a client is connected. |
| tpgetorgnode | Returns the node number to which a client is connected. |
| tpgetpeer_ipaddr | Returns a peer's IP address (node). |
| tpgetsvcname | Uses a service index to retrieve the name of a service. |
| tpgetsvrseqno | Returns the serial number of a server process from duplicate server processes. |
| tpissetfd | Checks if data is received in a socket fd in a UCS process. |
| tpissetfd_w | Tests a fdset used by a UCS-type process to check if there is any data to be sent to a socket fd specified in a parameter |
| tpprechk | A user callback routine to check the status of a RM. This function is called before a client connects to a Tmax system. |
| tpregcb | Sets a routine to be executed when a reply from a server program is received in a UCS type process. |
| tprelay | Forwards a service request to another service routine that contains the information of a client that requested a service. It is available only in UCS types of server process. |
| tpresumetx | Resumes a currently terminated global transaction. A terminated global transaction can be resumed using tpresumetx() or tpsuspendxt(). |
| return | End of a service routine. |
| tpsavectx | Internally manages client information. This function is used in a UCS process. |
| tpschedule | Sleeps until data arrives in a UCS-type server process. |
| tpsendtocli | Sends an unsolicited message to a specified client. |
| tpsetdbsessionid | Configures RM session information. |
| tpsuspendtx | Suspends a currently running global transaction. |
| tpsvctimeout | A routine called when a service timeout occurs. |
| tpsvrdone | Sets a routine to be executed when a server process goes down. |
| tpsvrdown | Used to down a UCS-type server process normally. |
| tpsvrinit | Initializes a Tmax server process. |
| tptsleep | Waits for TMM to send a server process termination event. |
| tpunadvertise | Unadvertises a service provided by a server process from a server. |
| tpunregcb | Reconfigures a routine to be executed when a reply to an asynchronous request is received from a server program. |
| tpuschedule | Waits for data to arrive in a UCS-type server process. |
| tx_close | Closes a connection with resource managers. |
| tx_open | Opens a connection with resource managers. |
| Function | Description |
|---|---|
| gettpurcode | Returns a urcode that is set in a urcode service to a client. |
| tpchkunsol | Triggers checking for unsolicited messages. |
| tpend | Ends a connection with a Tmax system. |
| tpgethostaddr | Checks the connectivity status of a Tmax client to a Tmax system or looks up IP/PORT information of a Tmax system. |
| tpgetunsol | Receives and processes messages sent unilaterally without the as request. |
| tpinit | Connects to a Tmax system. |
| tpreset | Closes a current connection immediately. |
| tpsetunsol | Sets a routine to execute when an unsolicted message from a server program is received. |
| tpsetunsol_flag | Changes an unsolicited message reception flag. |
| tpstart | Starts a connection to a Tmax system. |
| tpterm | Terminates a connection to a Tmax system. |
| tptobackup | Connects to a Tmax backup system. |
| Function | Description |
|---|---|
| chk_extpong_msg | Checks a message received from a remote server when checking a ping. |
| reset_extping_msg | Periodically called to reconfigure a ping message in a TCP/IP gateway. |
| set_extping_msg | Configures a message to be sent when checking a ping to a local or remote server. |
| Function | Description |
|---|---|
| tdlcall | Calls the latest version of a dynamic module function. |
| tdlcall2 | Calls the latest version of a dynamic module function. |
| tdlcall2s | Calls the latest version of a dynamic module function. |
| tdlcall2v | Calls the latest version of a dynamic module function. |
| tdlcallva | Calls the latest version of a dynamic module function. |
| tdlcallva2 | Calls the latest version of a dynamic module function. |
| tdlcreate | Creates a class instance using a Class Factory in the latest version of a dynamic module. It can be used when a VERSION is set to 4 in a TDL configuration file (tdl.cfg). |
| tdldestroy | Destroys a class instance using a Class Factory in the latest version of a dynamic module. It can be used when a VERSION is set to 4 in a TDL configuration file (tdl.cfg). |
| tdlend | Stops maintaining Explicit Version Consistency. |
| tdlerror | Converts a tdlcall function error to a character string. |
| tdlresume | Resumes a temporarily suspended Explicit Version Consistency. |
| tdlstart | Starts maintaining an Explicit Version Consistency. |
| tdlsuspend | Temporarily suspends the maintenance of an Explicit Version Consistency. |
| tdlgetseqno | Retrieves a global sequence number. |
| tdlclose | Initializes a reference count of a module to 0 or releases a module from memory. |
| tdlload | Searches for a hash table and load libraries, and then saves the corresponding module information in a local cache before calling a tdlcall(). |
| tdlload2 | Searches for a hash table and load libraries, and then saves the corresponding module information in a local cache before calling a tdlcall(). |
| tdlinit | Initially sets shared memory. |
| tdldone | Initializes shared memory. |
| tdlfind | Searches for a module index. |
| tdlfind2 | Searches for a module index. |
| tdlstat | Displays TDL statistics. |
| tdlstat2 | Displays TDL statistics. |
| Function | Description |
|---|---|
| WinTmaxAcall | Sends an asynchronous service request in a multithread environment. |
| WinTmaxAcall2 | Sends an asynchronous service request in a multithread environment. |
| WinTmaxEnd | Closes a connection with a Tmax system. |
| WinTmaxSend | Sends data. |
| WinTmaxSetContext | Specifies a Windows handle and message type. |
| WinTmaxStart | Connects to a Tmax system in a multi-Windows environment. |
| Function | Description |
|---|---|
| tlog_close | Closes a log file as a function that analyze transaction logs. |
| tlog_find | Finds an entry from a transaction log file that matches specified information. |
| tlog_nodeno | Finds the number of a node in which a transaction starts using XID. |
| tlog_open | Opens a log file as a function that analyzes transaction logs. |
| Usiginit | Initializes a Tmax signal handler as a function used to set macros, which is necessary for user signal handling. |
| Usignal | Sets macros for user signal handling. It is not used in a Windows system environment. |
| Uunixerr | A variable that sets an integrated error code when an error occurs during a system call. |
| Uunix_err | Writes a system error type to a stderr when an ATMI API call fails and a tperrno is set to TPEOS. |
| Ustrerror | Returns an integrated error message for a system error code (errno). |