IPacketQueue¶

module interface IPacketQueue

Interface for packet queue modules. A packet queue is a passive module which has one passive input and one passive output. Packets pushed into the passive input are either stored or dropped. Packets pulled from the passive output are provided from the stored packets.

Usage diagram¶

Inheritance diagram¶

Implemented by¶

Name	Type	Description
EthernetQosQueue	compound module	Queue module that gives the PAUSE frames a higher priority, and can be parametrized with an IPacketQueue for serving the data frames.
EthernetQosRedQueue	compound module	Queue module that gives the PAUSE frames a higher priority, and using Random Early Detection algorithm on data frames, and can be parametrized with an IPacketQueue for serving the data frames.
EthernetQueue	compound module	Queue module that gives the PAUSE frames a higher priority.
EthernetGatingQueue	compound module	(no description)
EthernetPriorityQueue	compound module	(no description)
CompoundPendingQueue	compound module	Implements a prioritized queue system for IEEE 802.11 MAC frames. Uses a classifier to separate incoming packets into three queues: management frames (highest priority), multicast frames (medium priority), and unicast frames (lowest priority). A priority scheduler then selects packets from these queues in order of priority.
PendingQueue	simple module	Implements a priority queue for IEEE 802.11 MAC frames. Uses a comparator to determine the order in which frames are processed. By default, prioritizes management frames over data frames, but can be configured to use different prioritization schemes such as management over multicast over unicast frames.
Ieee8021qTimeAwareShaper	compound module	Implements the IEEE 802.1Q time aware shaper.
DiffservQueue	compound module	This is an example queue that can be used in interfaces of DS core and edge nodes to support the AFxy (RFC 2597) and EF (RFC 3246) PHBs.
EligibilityTimeQueue	simple module	A packet queue that keeps the packets in ascending order based on the eligibility time in the attached EligibilityTimeTag of the packets.
CompoundPacketQueueBase	compound module	This compound module serves as a base module for complex packet queues formed by combining several queueing components.
DropHeadQueue	simple module	This is a limited packet queue that drops packets at the head of the queue.
DropTailQueue	simple module	A limited packet queue that drops packets at the tail of the queue.
GatingPriorityQueue	compound module	Implements a priority queue with multiple inner queues each having its own periodic gate for packet selection and an optional shared memory buffer.
GatingQueue	compound module	Implements a queue having its own periodic gate.
InProgressQueue	simple module	Specialized packet queue that only accepts packets with higher priority than those already in the queue. Unlike standard packet queues, it always returns false for canPushSomePacket() and only allows insertion of packets that compare favorably against the first packet in the queue according to the configured comparator function (see comparatorClass parameter). Useful for implementing priority-based packet processing where only higher priority packets can preempt currently queued packets.
OmittedPacketQueue	compound module	Implements the given module interface and can be used as an optional module that removes itself from the module hierarchy during initialization.
PacketQueue	simple module	Implements a configurable packet queue, which is suitable for use in MAC protocols, traffic conditioning, and quality of services, among others. This is a passive component: packets are pushed into it on its input, and pulled from it on its output. This module can be used on its own, but it’s also often supplemented by additional queueing components such as servers, classifiers, schedulers, multiplexers, etc. This kind of composition allows to form a larger module which can act as a packet queue with more complex behavior.
PriorityQueue	compound module	Implements a priority queue with multiple inner queues and an optional shared memory buffer.
RedDropperQueue	compound module	Combines a packet queue with random early detection (RED) dropper.
PriorityShaper	compound module	Combines a classifier, a scheduler, and several traffic shapers into a single packet shaper. Packets are classified into one of the traffic shapers, and the scheduler prioritizes among them.

Used in compound modules¶

Name	Type	Description
EthernetPreemptingMacLayer	compound module	(no description)

Extends¶

Name	Type	Description
IPassivePacketSink	module interface	Interface for passive packet sink modules. A passive packet sink, also called a consumer, has one input that must be connected to an active packet source module. The connected active packet source is expected to push packets into the passive packet sink over time.
IPassivePacketSource	module interface	Interface for passive packet source modules. A passive packet source, also called a provider, has one output that must be connected to an active packet sink module. The connected active packet sink is expected to pull packets from the passive packet source over time.

Properties¶

Name	Value	Description
display	i=block/queue
omittedTypename	OmittedPacketQueue

Source code¶

//
// Interface for packet queue modules. A packet queue
// is a passive module which has one passive input and one passive output.
// Packets pushed into the passive input are either stored or dropped. Packets
// pulled from the passive output are provided from the stored packets.
//
moduleinterface IPacketQueue extends IPassivePacketSink, IPassivePacketSource
{
    parameters:
        @omittedTypename(OmittedPacketQueue);
        @display("i=block/queue");
}

File: src/inet/queueing/contract/IPacketQueue.ned