Technical Reference: Base Operating System and Extensions, Volume 2

RSiStopFeed Subroutine

Purpose

Tells xmservd to stop sending data feeds for a statset.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

int RSiStopFeed(rhandle, statset, erase)
RSiHandle rhandle;
struct SpmiStatSet *statset;
boolean erase;

Description

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

Stop sending data_feed packets for a given SpmiStatSet. If the daemon is not told to erase the SpmiStatSet, feeding of data can be resumed by issuing the RSiStartFeed (RSiStartFeed Subroutine) subroutine call for the SpmiStatSet.
Optionally tells the daemon and the API library subroutines to erase all their information about the SpmiStatSet. Subsequent references to the erased SpmiStatSet are not valid.

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

Parameters

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

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

eraseIf this argument is set to true, the xmservd daemon on the remote host discards all information about the named SpmiStatSet. 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.

Files

/usr/include/sys/Rsi.h

Declares the subroutines, data structures, handles, and macros that an application program can use to access the RSI.

Related Information

For related information, see: