TPUNADVERTISE - Unadvertise a service name

01  SERVICE-NAME  PIC X(15).
01  TPSTATUS-REC.
    COPY  TPSTATUS.
 
CALL  "TPUNADVERTISE"  USING  SERVICE-NAME  TPSTATUS-REC.

TPUNADVERTISE allows a server to unadvertise a service that it offers. By default, a server's services are advertised when it is booted and they are unadvertised when it is shutdown.

TPUNADVERTISE removes SERVICE-NAME as an advertised service for the server. SERVICE-NAME cannot be SPACES. Also, SERVICE-NAME should be 15 characters or fewer. Longer names are accepted and truncated to 15 characters. Care should be taken such that truncated names do not match other service names.

<<SERVICE-NAME

Specify the service name of the service.>>

<<TPSTATUS-REC

Will be assigned the return value indicating the result of TPUNADVERTISE execution.>>

Upon successful completion, TPUNADVERTISE sets TP-STATUS to TPOK.

Errors

Under the following conditions, TPUNADVERTISE fails and sets TP-STATUS to one of the following values:

TPEINVAL: SERVICE-NAME is SPACES.

TPENOENT: SERVICE-NAME is not currently advertised by the server.

TPEPROTO: TPUNADVERTISE was called in an improper context.

TPESYSTEM: A communication resource manager system error has occurred. The exact nature of the error is determined in a product-specific manner.

TPEOS: An operating system error has occurred. The exact nature of the error is determined in a product-specific manner.

<<Suppose that load balancing is used on one node (multiserver configuration). When the function TPUNADVERTISE is invoked from one of the processes, the service becomes unavailable to all processes which undergo load balancing. When the function TPADVERTISE is later invoked to advertise the service, service requests from the processes can be accepted.>>
<<Suppose that load balancing is used on multiple nodes (internode load-balancing and extended internode load-balancing). When the function TPUNADVERTISE is invoked from a process on a node, the service becomes unavailable on that node. However, the servers at other nodes can accept service requests. When the function TPADVERTISE is later invoked to advertise the service, service requests are acceptable.>>