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

Page 43: Os_udp::src, Chapter 4

Advertising
background image

Brocade Virtual ADX OpenScript API Guide

31

53-1003243-01

Chapter

4

UDP API reference

In this chapter

This chapter contains the following sections:

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Overview

The OS_UDP module includes the APIs to retrieve the fields in the current UDP header.

The use <package> 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_UDP methods, The OS_UDP package must be declared as follows:

use OS_UDP;

Methods

OS_UDP::src

Description

Returns the source port number if called in the correct context, otherwise undefined is returned.

Context

Called in UDP context.

Usage

Can be used to perform load-balancing based on the source port.

Input Parameters

None.

Advertising