beautypg.com

Connection api reference, Overview, Methods – Brocade Virtual ADX OpenScript API Guide (Supporting ADX v03.1.00) User Manual

Page 119: Os_conn::client_connection, Chapter 8, Context, Usage, Input parameters

background image

Brocade Virtual ADX OpenScript API Guide

107

53-1003243-01

Chapter

8

Connection API Reference

In this chapter

This chapter contains the following sections:

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Overview

The OS_CONN module includes the APIs to retrieve the information about client and server
connections. These APIs can be called from any event.

The use statement needs to be in the declaration block of the script for methods of that
package to be used.

For example: to use the OS_CONN methods, The OS_CONN package must be declared as follows:

use OS_CONN;

Methods

OS_CONN::client_connection

Returns the CPU unique session index number for the client connection.

Context

This function can be called from any event.

Usage

Can be used to create the hash table which stores the connection specific information.

Input Parameters

The following table contains the input values.

TABLE 128

Input Values

Name

Type

Description

integer

The client connection number.