Print Page as PDF
SERVER MESSAGE API ICR (10072)

SERVER MESSAGE API    ICR (10072)

Name Value
NUMBER 10072
IA # 10072
DATE CREATED 1995/02/06
CUSTODIAL PACKAGE MAILMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XMA1C
NAME SERVER MESSAGE API
ORIGINAL NUMBER 10072
GENERAL DESCRIPTION 
This API deals with server messages:
- REMSBMSG^XMA1C  remove a message from a server basket
- SETSB^XMA1C     put a message into a server basket

Server messages are usually placed in one of the Postmaster's server baskets
(using SETSB^XMA1C) upon receipt of the message, and deleted from the basket
(using REMSBMSG^XMA1C) upon successful processing of the message by the
application to which the server belongs.  See the Kernel Systems Manual for
more information on servers.
STATUS Active
ID XMA1C
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
SETSB 
Put a message in a server basket.

Servers may use this entry point to put messages into a Postmaster server
basket to protect the message from automatic purges.  TaskMan uses it to place
server messages in a server basket if the server SAVE REQUEST field in the
OPTION file is 1.  A server might use this entry point if the message cannot
be processed immediately (and SAVE REQUEST was not 1) or if the server wishes
to pass the message to another server.

As long as the message is in a server basket, MailMan will not purge it.

Compare to PUTSERV^XMXAPI (DBIA 2729).

Usage: S XMXX=full server basket name, beginning with "S."
S XMZ=message IEN
D SETSB^XMA1C
VARIABLES TYPE VARIABLES DESCRIPTION
XMXX Input 
Full name of the server basket, preceded by "S.",
into which the message should be put.  Note that the server basket name is the
same as the server option name.
XMZ Input 
Message IEN in the Message file of the message to be
put into the server basket.
REMSBMSG 
Remove a message from a server basket.

When the application which uses the server basket has finished processing a
message in that basket, it should remove the message from the server basket.
Otherwise, the message will stay forever.  MailMan will not purge any message
which is in a server basket.

Upon exit, the following variables are killed: XMKD, XMZ, XMDUZ, XMK, XMSER

Compare to ZAPSERV^XMXAPI (DBIA 2729).

Usage: S XMSER=full server name, beginning with "S."
S XMZ=message IEN
D REMSBMSG^XMA1C
VARIABLES TYPE VARIABLES DESCRIPTION
XMSER Input 
Full name of the server basket, preceded by "S.",
from which the message is to be removed.  Note that the server basket name is
the same as the server option name.
XMZ Input 
Message IEN in the Message file of the server message
to be removed.