RSiClose Subroutine

Purpose

Terminates the Remote Statistic Interface (RSI) interface for a remote host connection.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

void RSiClose(rhandle)
RSiHandle rhandle;

Description

The RSiClose subroutine is responsible for:

1. Removing the data-consumer program as a known data consumer on a particular host. This is done by sending a going_down packet to the host.
2. Marking the RSI handle as not active.
3. Releasing all memory allocated in connection with the RSI handle.
4. Terminating the RSI interface for a remote host.

A successful RSiOpen (RSiOpen Subroutine) subroutine creates tables on the remote host it was issued against. Therefore, a data consumer program that has issued successful RSiOpen subroutine calls should issue an RSiClose (RSiClose Subroutine) subroutine call for each RSiOpen call before the program exits so that the tables in the remote xmservd daemon can be released.

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.

The macro RSiIsOpen can be used to test whether an RSI handle is open. It takes an RSiHandle as argument and returns true (1) if the handle is open, otherwise false (0).

Files