dequeue

Class: wnet.FIFOQueue
Namespace: wnet

Remove a packet from head of FIFO queue

Since R2026a

Syntax

packet = dequeue(queueObj)

Description

packet = dequeue(queueObj) removes the packet from the head of the first-in first-out (FIFO) queue queueObj, and returns the removed packet.

Examples

Create a FIFO Queue With Specified Number of Packets

Create a FIFO queue for 1000 packets.

queueObj = wnet.FIFOQueue(MaxSize=1000);

Create a sample packet and specify the packet size.

packet = [255;255];
packetSize = numel(packet);

Add the packet to the tail of the queue.

isQueued = enqueue(queueObj,packet,packetSize);

Get the number of packets in the queue.

numPackets = queueObj.CurrentSize;

Get the number of packet bytes in the queue.

nBytes = queueObj.CurrentSizeBytes;

Check if the queue is full.

status = isFull(queueObj);

Retrieve the first packet from the head of the queue.

PeekedPacket = peek(queueObj);

Remove the packet from the head of the queue.

dequeuedPacket = dequeue(queueObj);

Input Arguments

queueObj — FIFO queue

object of class wnet.FIFOQueue

FIFO queue, specified as an object of class wnet.FIFOQueue.

Output Arguments

packet — Packet removed from head of queue

[] (default) | any MATLAB^® data type

Packet removed from the head of the queue, returned as any MATLAB data type present at the head of the queue.

Version History

Introduced in R2026a