Array of items as a First-In-First-Out (FIFO) datastructure. More...
#include <Queue.h>
Public Member Functions | |
| Queue () | |
| Default constructor. More... | |
| bool | push (const T &item) |
| Add item to the head of the Queue. More... | |
| T & | pop () |
| Remove item from the tail of the Queue. More... | |
| bool | contains (const T &item) const |
| Look if an item exists on the Queue. More... | |
| Size | remove (T value) |
| Remove all items with the given value. More... | |
| virtual void | clear () |
| Removes all items from the Queue. More... | |
| virtual Size | size () const |
| Returns the maximum size of this Queue. More... | |
| virtual Size | count () const |
| Returns the number of items in the Queue. More... | |
 Public Member Functions inherited from Container | |
| Container () | |
| Constructor. More... | |
| virtual | ~Container () |
| Destructor. More... | |
| virtual bool | isEmpty () const |
| Check if the Container is empty. More... | |
| virtual bool | reserve (Size size) |
| Ensure that at least the given size is available. More... | |
| virtual bool | shrink (Size size) |
| Shrink the container size by the given amount of items. More... | |
| virtual Size | squeeze () |
| Try to minimize the memory required in the Container. More... | |
| virtual bool | resize (Size size) |
| Change the size of the Container. More... | |
Private Attributes | |
| T | m_array [N] |
| The actual array where the data is stored. More... | |
| uint | m_head |
| Head of the queue. More... | |
| uint | m_tail |
| Tail of the queue. More... | |
| uint | m_count |
| Number of items in the queue. More... | |
Detailed Description
template<class T, Size N>
class Queue< T, N >
Array of items as a First-In-First-Out (FIFO) datastructure.
Constructor & Destructor Documentation
◆ Queue()
Member Function Documentation
◆ clear()
|
inlinevirtual |
Removes all items from the Queue.
Implements Container.
Definition at line 131 of file Queue.h.
Referenced by Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::Queue().
◆ contains()
|
inline |
Look if an item exists on the Queue.
- Parameters
-
item Item reference
- Returns
- True if the item exists, false otherwise
Definition at line 92 of file Queue.h.
Referenced by ProcessManager::sleep().
◆ count()
Returns the number of items in the Queue.
Implements Container.
Definition at line 153 of file Queue.h.
Referenced by Scheduler::count(), Scheduler::dequeue(), Sun8iEmac::interrupt(), ProcessManager::schedule(), Scheduler::select(), Sun8iEmac::startDMA(), and Sun8iEmac::transmit().
◆ pop()
|
inline |
Remove item from the tail of the Queue.
- Returns
- Item T
- Note
- Do not call this function if the Queue is empty
Definition at line 76 of file Queue.h.
Referenced by Scheduler::dequeue(), Sun8iEmac::interrupt(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::remove(), ProcessManager::schedule(), Scheduler::select(), and Sun8iEmac::startDMA().
◆ push()
|
inline |
Add item to the head of the Queue.
- Parameters
-
item The item to add
- Returns
- True if successful, false otherwise
Definition at line 55 of file Queue.h.
Referenced by Scheduler::dequeue(), Scheduler::enqueue(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::remove(), ProcessManager::schedule(), Scheduler::select(), ProcessManager::sleep(), Sun8iEmac::startDMA(), and Sun8iEmac::transmit().
◆ remove()
Remove all items with the given value.
- Parameters
-
value Value to remove.
- Returns
- Number of items removed.
Definition at line 110 of file Queue.h.
Referenced by ProcessManager::enqueueProcess(), and ProcessManager::remove().
◆ size()
Field Documentation
◆ m_array
|
private |
The actual array where the data is stored.
Definition at line 161 of file Queue.h.
Referenced by Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::contains(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::pop(), and Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::push().
◆ m_count
Number of items in the queue.
Definition at line 170 of file Queue.h.
Referenced by Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::clear(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::contains(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::count(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::pop(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::push(), and Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::remove().
◆ m_head
Head of the queue.
Definition at line 164 of file Queue.h.
Referenced by Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::clear(), and Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::push().
◆ m_tail
Tail of the queue.
Definition at line 167 of file Queue.h.
Referenced by Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::clear(), Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::contains(), and Queue< NetworkQueue::Packet *, NetworkQueue::MaxPackets >::pop().
The documentation for this class was generated from the following file:
- lib/libstd/Queue.h
