InteractiveGate¶

simple module InteractiveGate

This packet gate module allows or forbids packets to pass through depending on whether the gate is open or closed as specified by the parameter. The gate can also be controlled by the user by manually changing the open parameter from the graphical user interface while the simulation is paused.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
DualIeee8021qFilter	compound module	Combines two meters and their corresponding filters per path. This is primarily useful for combining a token bucket based metering with an asynchronous packet shaper. Note that the asynchronous packet shaper also has parts in the network interface queue module.
Ieee8021qFilter	compound module	Implements the IEEE 802.1Q per-stream filtering and policing. The relationship between streams, gates, and meters is not one-to-one. The number of streams, gates, and meters can be different, and the module will take care of the connections between the submodules based on the `streamFilterTable` parameter.
SimpleIeee8021qFilter	compound module	Implements a simplified version of the IEEE 802.1Q per-stream filtering and policing. Each filtered stream has its own path where metering and filtering happens independently of any other stream.

Extends¶

Name	Type	Description
PacketGateBase	simple module	Base module for various packet gate modules.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“passed %p pk (%l)”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
bitrate	double	nan bps
extraLength	int	0b
extraDuration	double	0s
open	bool	true

Properties¶

Name	Value	Description
class	InteractiveGate
display	i=block/cogwheel

Gates¶

Name	Direction	Size	Description
in	input
out	output

Signals¶

Name	Type	Unit	Description
gateStateChanged	bool
packetPulledIn	inet::Packet
packetPulledOut	inet::Packet
packetPushedIn	inet::Packet
packetPushedOut	inet::Packet

Statistics¶

Name	Title	Source	Record	Unit	Interpolation Mode	Description
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear	the statistical value is the flow specific data rate of the incoming packets
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the incoming packet
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear	the statistical value is the flow specific data rate of the outgoing packets
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the outgoing packet
gateState	gate state	gateStateChanged	vector		sample-hold
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear	the statistical value is the data rate of the incoming packets
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum,histogram,vector	b	none	the statistical value is the length of the incoming packet
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk		the statistical value is the incoming packet
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear	the statistical value is the data rate of the outgoing packets
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum,histogram,vector	b	none	the statistical value is the length of the outgoing packet
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk		the statistical value is the outgoing packet

Source code¶

//
// This packet gate module allows or forbids packets to pass through depending
// on whether the gate is open or closed as specified by the parameter. The gate
// can also be controlled by the user by manually changing the open parameter
// from the graphical user interface while the simulation is paused.
//
simple InteractiveGate extends PacketGateBase like IPacketGate
{
    parameters:
        bool open @mutable = default(true);
        @class(InteractiveGate);
}

File: src/inet/queueing/gate/InteractiveGate.ned