ArmSys Support
ArmsysApi  0.12.18
BQueue< T > Class Template Reference

Queue class. More...

#include <BQueue.h>

Public Member Functions

 BQueue (BUInt size)
 
 ~BQueue ()
 
void clear ()
 Clears a queue. More...
 
BUInt writeAvailable ()
 
BUInt readAvailable ()
 
BUInt readAvailableFromIsr ()
 
BError write (const T &v, BTimeout timeoutUs=BTimeoutForever)
 Append an item onto the queue. More...
 
BError read (T &v, BTimeout timeoutUs=BTimeoutForever)
 Get an item from the queue. More...
 
BError writeFromIsr (const T &v)
 Append an item onto the queue. More...
 
BError readFromIsr (T &v)
 Get an item from the queue. More...
 

Protected Attributes

QueueHandle_t oqueue
 

Detailed Description

template<class T>
class BQueue< T >

Queue class.

Constructor & Destructor Documentation

◆ BQueue()

template<class T >
BQueue< T >::BQueue ( BUInt  size)

◆ ~BQueue()

template<class T >
BQueue< T >::~BQueue ( )

Member Function Documentation

◆ clear()

template<class T >
void BQueue< T >::clear ( )

Clears a queue.

◆ read()

template<class T>
BError BQueue< T >::read ( T &  v,
BTimeout  timeoutUs = BTimeoutForever 
)

Get an item from the queue.

◆ readAvailable()

template<class T >
BUInt BQueue< T >::readAvailable ( )

◆ readAvailableFromIsr()

template<class T >
BUInt BQueue< T >::readAvailableFromIsr ( )

◆ readFromIsr()

template<class T>
BError BQueue< T >::readFromIsr ( T &  v)

Get an item from the queue.

◆ write()

template<class T>
BError BQueue< T >::write ( const T &  v,
BTimeout  timeoutUs = BTimeoutForever 
)

Append an item onto the queue.

◆ writeAvailable()

template<class T >
BUInt BQueue< T >::writeAvailable ( )

◆ writeFromIsr()

template<class T>
BError BQueue< T >::writeFromIsr ( const T &  v)

Append an item onto the queue.

Member Data Documentation

◆ oqueue

template<class T>
QueueHandle_t BQueue< T >::oqueue
protected

The documentation for this class was generated from the following file: