FrameSizeModifier.Random Class Reference

A frame size modifier which will change the size of the frame randomly between a minimum and maximum value. More...

Methods
	Description.Get
	Returns a textual description of the object.
	Maximum.Get
	Method to get the current configured maximum frame size. More...
	Maximum.Set maximum
	Sets the Maximum size of a Frame of a flow with FrameModifier.RandomSize. More...
	Minimum.Get
	Method to get the currently configured minimum frame size. More...
	Minimum.Set minimum
	Sets the Minimum size of a Frame of a flow with FrameModifier.RandomSize. More...
	Parent.Get
	Returns the parent object.
	Result.Get
	Returns the accumulated counters. More...

Class overview

A frame size modifier which will change the size of the frame randomly between a minimum and maximum value.

Since

2.3.0

ByteBlower allows different modifiers on a Frame. Some modifiers work on the size of a frame, others content. The FrameModifier.RandomSize is a modifier which modifies the size of the frame.

A FrameModifier.RandomSize will change the frame size randomly. The following parameters can be configured:

Minimum size

the minimum frame size.

Maximum size

the maximum frame size.

So, a stream with a FrameModifier.RandomSize installed, will start sending frames with a size randomly chosen between <Minimum size> size and <Maximum size> size. Each time a frame is sent, a new size is selected.

All sizes are without the additional 4 bytes Ethernet checksum.

The frame size modifier will change the sizes of the Frames added to the stream. If the original frame size is bigger, the size will truncated to the requested frame size. If automatic checksum calculations have been enabled on the Frame, they will be recalculated. This depends on the configuration of the Frame. See the Frame documentation on how this can be done.

If the original frame size of a Frame is too short, the Frame will be padded with zero-value bytes.

Definition at line 4404 of file api.tcl.

Method documentation

FrameSizeModifier.Random::Maximum.Get

Method to get the current configured maximum frame size.

Returns

The maximum frame size which will be used for a random size flow.

Example

This example shows how to retrieve the current maximum frame size.

$FrameSizeModifierRandom Maximum.Get

Returns:

1514 

Definition at line 4421 of file api.tcl.

FrameSizeModifier.Random::Maximum.Set			maximum

Sets the Maximum size of a Frame of a flow with FrameModifier.RandomSize.

This defines the maximum frame size of the stream.

Parameters

maximum

Maximum byte length of the Frame. This value must be at least 61 bytes, and maximum 8192. The value must also be bigger than the <Minimum size> configured. Default: 1514

Exceptions

tclerror

Maximum too small or too big.

Example

This example will set the maximum frame size to 128 bytes.

$FrameSizeModifierRandom Maximum.Set 128

Definition at line 4437 of file api.tcl.

FrameSizeModifier.Random::Minimum.Get

Method to get the currently configured minimum frame size.

Returns

The minimum frame size which will be used for a random size flow.

Example

This example shows how to retrieve the current minimum frame size.

$FrameSizeModifierRandom Minimum.Get

Returns:

60 

Definition at line 4449 of file api.tcl.

FrameSizeModifier.Random::Minimum.Set			minimum

Sets the Minimum size of a Frame of a flow with FrameModifier.RandomSize.

This defines the minimal frame size of the stream.

Parameters

minimum

Minimum byte length of the Frame. This value must be at least 60 bytes, and maximum 8191. The value must also be less than the <Maximum size> configured. Default: 60

Exceptions

tclerror

Minimum too small or too big.

Example

This example will set the minimum frame size to 128 bytes.

$FrameSizeModifierRandom Minimum.Set 128

Definition at line 4465 of file api.tcl.

FrameSizeModifier.Random::Result.Get

Returns the accumulated counters.

Returns

Returns an object obj type FrameSizeModifier.Result which contains the accumulated result counters.

Example

$sizeModifier Result.Get

Returns:

<FrameSizeModifier.Result object> 

Definition at line 4482 of file api.tcl.