PURPOSE

TPCHKUNSOL - check for unsolicited message

SYNOPSIS


01 MSG-NUM  PIC S9(9)  COMP-5.
01 TPSTATUS-REC.
   COPY TPSTATUS.
CALL "TPCHKUNSOL" USING MSG-NUM TPSTATUS-REC.

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. Calls to this routine can result in calls to an application-defined unsolicited message handling routine by the System/T libraries.

RETURN VALUES

Upon successful completion, TPCHKUNSOL sets TP-STATUS to [TPOK] and returns the number of unsolicited messages dispatched in MSG-NUM.

ERRORS

Under the following conditions, TPCHKUNSOL fails and sets TP-STATUS to:

[TPEPROTO]: TPCHKUNSOL was called in an improper context (e.g., from within a server).
[TPESYSTEM]: A System/T 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(3cbl) are supported on native site UNIX-based processors. In addition, the routines TPBROADCAST(3cbl) and TPCHKUNSOL(3cbl) as well as the routine 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 ubbconfig(5) description of the *RESOURCES NOTIFY parameter for a detailed discussion of notification methods) Note that signaling of clients is always done by the system so that the behavior of notification is consistent regardless of where the originating notification call is made. Because of this, only clients running as the application administrator can use signal-based notification. The id for the application administrator is identified as part of the configuration file for the application.