Technical Reference: Base Operating System and Extensions , Volume 2

RSiStopHotFeed Subroutine

Purpose

Tells xmservd to stop sending hot feeds for a hotset and to stop checking for exception and SNMP trap generation.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

int RSiStopFeed(rhandle, hotset, erase)
RSiHandle rhandle;
struct SpmiHotSet *hotset;
boolean erase;

Description

The RSiStopHotFeed subroutine instructs the xmservd of a remote system to:

1. Stop sending hot_feed packets or check if exceptions or SNMP traps should be generated for a given SpmiHotSet. If the daemon is not told to erase the SpmiHotSet, feeding of data can be resumed by issuing the RSiStartHotFeed (RSiStartHotFeed Subroutine) subroutine call for the SpmiHotSet.
2. Optionally tells the daemon and the API library subroutines to erase all their information about the SpmiHotSet. Subsequent references to the erased SpmiHotSet are not valid.

Parameters

rhandleMust point to a structure of type RSiHandle, which was previously initialized by the RSiOpen (RSiOpen Subroutine) subroutine.

hotsetMust be a pointer to a structure of type struct SpmiHotSet, which was previously returned by a successful RSiCreateHotSet (RSiCreateHotSet Subroutine) subroutine call. Data feeding must have been started for this SpmiStatSet via a previous RSiStartHotFeed (RSiStartHotFeed Subroutine) subroutine call.

eraseIf this argument is set to true, the xmservd daemon on the remote host discards all information about the named SpmiHotSet. Otherwise the daemon maintains its definition of the set of statistics.

Return Values

If successful, the subroutine returns zero, otherwise -1. A NULL error text is placed in the external character array RSiEMsg regardless of the subroutine's success or failure.

Error Codes

All RSI subroutines use external variables to provide error information. To access these variables, an application program must define the following external variables:

• extern char RSiEMsg[];
• extern int RSiErrno;

If the subroutine returns without an error, the RSiErrno variable is set to RSiOkay and the RSiEMsg character array is empty. If an error is detected, the RSiErrno variable returns an error code, as defined in the enum RSiErrorType. RSi error codes are described in List of RSi Error Codes.

Implementation Specifics

This subroutine is part of the Performance Toolbox for AIX licensed product.

Files

Related Information

For related information, see:

• RSiOpen Subroutine
• RSiStartHotFeed Subroutine
• RSiChangeHotFeed Subroutine.