RSiStartHotFeed Subroutine

Purpose

Tells xmservd to start sending hot feeds for a hotset or to start checking for if exceptions or SNMP traps should be generated.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h
int RSiStartFeed(rhandle, hotset, msecs)
RSiHandle rhandle;
struct SpmiHotSet *hotset;
int msecs;

Description

The RSiStartHotFeed subroutine performs the following function:

  1. Informs xmservd of the frequency with which it is required to send hot_feed packets, if the hotset is defined to generate hot_feed packets.
  2. Informs xmservd of the frequency with which it is required to check if exceptions or SNMP traps should be generated. This is only done if it is specified for the hotset that exceptions and/or SNMP traps should be generated.
  3. Tells the xmservd to start sending data_feed packets and/or start checking for exceptions or traps.

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

Parameters

rhandle
Must point to a valid RSiHandle handle, which was previously initialized by the RSiOpen (RSiOpen Subroutine) subroutine.
hotset
Must be a pointer to a structure of type struc SpmiHotSet, which was previously returned by a successful RSiCreateHot (RSiCreateHotSet Subroutine) subroutine call.
msecs
The number of milliseconds between the sending of hot_feed packets and/or the number of milliseconds between checks for if exceptions or SNMP traps should be generated. This number is rounded to a multiple of min_remote_int milliseconds by the xmservd daemon on the remote host. This minimum interval can be modified through the -i command line interval to xmservd.

Return Values

If successful, the subroutine returns zero; otherwise it returns -1 and an error text may be placed in the external character array RSiEMsg.

Error Codes

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

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.

Files

Item Description
/usr/include/sys/Rsi.h Declares the subroutines, data structures, handles, and macros that an application program can use to access the RSI.