Brocade Virtual ADX OpenScript API Guide (Supporting ADX v03.1.00) - Manual (Page 3)

Brocade Virtual ADX OpenScript API Guide iii
53-1003243-01
Contents
Preface
Document conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Text formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Command syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Notes, cautions, and warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Brocade resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Contacting Brocade Technical Support . . . . . . . . . . . . . . . . . . . . . . . . xi
Document feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Chapter 1 About OpenScript
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
General nomenclature of functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Extensions and events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Error handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Syntax checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Default action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Reducing memory usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Example: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 2 IP API reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
OS_IP::src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
OS_IP::dst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
OS_IP::protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
OS_IP::flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
OS_IP::tos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
OS_IP::options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
OS_IP::getHeaderLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
OS_IP::getPayloadLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
OS_IP::getOptionsLength. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
OS_IP::raw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 3 TCP API reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17