enqueue

Class: wnet.FIFOQueue
Namespace: wnet

Add a packet to tail of FIFO queue

Since R2026a

expand all in page

Syntax

isQueued = enqueue(queueObj,packet)
isQueued = enqueue(queueObj,packet,size)

Description

isQueued = enqueue(queueObj,packet) adds the packet packet to the tail of the first-in first-out (FIFO) queue queueObj, and returns the status of the packet addition.

isQueued = enqueue(queueObj,packet,size) adds the packet packet of specified size size to the tail of the FIFO queue queueObj, and returns the status of the packet addition.

example

Examples

expand all

Open Live Script

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

expand all

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

Packet to add at the tail of the FIFO queue, specified as any MATLAB data type.

Size of the specified packet in bytes, specified as a nonnegative integer. This value represents the number of data bytes required to hold the specified packet. If no value is specified, the enqueue function assumes that the specified packet size is 0 bytes.

Output Arguments

expand all

Status of the packet addition, returned as a numeric or logical 0(false) or 1(true).

Data Types: logical

Version History

Introduced in R2026a

See Also

Classes

Functions