streamRegion

streamRegion - manage setting that apply to all streams

SYNOPSIS

streamRegion sub-command options

DESCRIPTION

The streamRegion command is used to manage several properties that apply to all streams.

STANDARD OPTIONS
gapControlMode

For ports that have the portFeatureGapControlMode capability, this controls the manner in which minimum inter-packet gaps are enforced.

Option

Value

Usage

streamGapControlFixed

0

(default) All gaps are a minimum of 12 bytes.

streamGapControlAverage

1

The gaps are averaged to 12 bytes in such a way that the deficit at any point in time is no more than 3 bytes.

totalAverageBpsRate

Read-only. The calculated total average bits per second rate.

totalAverageFpsRate

Read-only. The calculated total average frames per second rate.

totalAveragePercent
MaxRate

Read-only. The calculated total average percent of maximum bit rate.

COMMANDS

The streamRegion command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.

streamRegion cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the streamRegion command.

streamRegion config option value

Modify the stream region options. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS).

streamRegion enableGenerateWarningList value

If true, enables the validation of all inner stream relationships and generates warnings each time stream set is called. See generateWarningList, below. If disabled (set to false) both the generation of the warning list and the validation for the region are disabled. Additionally, stream cget -warnings may not contain the correct warnings for the region. (default = true)

streamRegion generateWarningList chasID cardID portID

Validates all inner stream relationships AND generates the warning list for each stream, returning in a list of lists of strings of warnings per each stream.

Regardless of how enableGenerateWarningList is set, this command generates a list of lists of warnings per each stream. If a stream has no warnings, the list is empty.

Note: If warning generation is disabled (by the command enableGenerate
WarningList = false), you MUST call generateWarningList before committing to hardware, regardless of whether you care about the warning list or not, because this command validates on all the streams in the region. Validation is required prior to a write to hardware.

streamRegion get chasID cardID portID

Gets the current configuration of the streamRegion for the indicated port.Call this command before calling streamRegion cget option value to get the value of the configuration option. Specific errors are:

streamRegion set chasID cardID portID

Sets the configuration of the stream region for the indicated port.

streamRegion setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES
SEE ALSO

stream