Section 3c - C Functions

ATMI C Function Reference

tpchkunsol(3c)

Name

tpchkunsol()—Routine for checking for unsolicited message.

Synopsis

#include <atmi.h> 
int tpchkunsol(void)

Description

tpchkunsol() is used by a client to trigger checking for unsolicited messages. Calls to this routine in a client using signal-based notification do nothing and return immediately. This call has no arguments. Calls to this routine can result in calls to an application-defined unsolicited message handling routine by the BEA Tuxedo ATMI system libraries.

In a multithreaded application, a thread in the TPINVALIDCONTEXT state is not allowed to issue a call to tpchkunsol().

Return Values

Upon successful completion, tpchkunsol() returns the number of unsolicited messages dispatched; otherwise it returns -1 and sets tperrno to indicate the error condition.

Errors

Upon failure, tpchkunsol() sets tperrno to one of the following values:

[TPEPROTO]

tpchkunsol() was called in an improper context (for example, from within a server).

[TPESYSTEM]

A BEA Tuxedo system error has occurred. The exact nature of the error is written to a log file.

[TPEOS]

An operating system error has occurred.

Portability

The interfaces described in tpnotify(3c) are supported on native site UNIX-based processors. In addition, the routines tpbroadcast() and tpchkunsol() as well as the function tpsetunsol() are supported on UNIX and MS-DOS workstation processors.

Clients that select signal-based notification may not be signal-able by the system due to signal restrictions. When this occurs, the system generates a log message that it is switching notification for the selected client to dip-in and the client is notified then and thereafter via dip-in notification. (See the description of the RESOURCES NOTIFY parameter in UBBCONFIG(5) for a detailed discussion of notification methods.)

Because signaling of clients is always done by the system, the behavior of notification is always consistent, regardless of where the originating notification call is made. Therefore to use signal-based notification:

A native client must be running as an application administrator
A Workstation client is not required to be running as the application administrator

The ID for the application administrator is identified as part of the configuration for the application.

If signal-based notification is selected for a client, then certain ATMI calls can fail, returning TPGOTSIG due to receipt of an unsolicited message if TPSIGRSTRT is not specified. See UBBCONFIG(5) and tpinit(3c) for more information on notification method selection.