Sirikata::Queue< ElementType, SizeFunctorType > Class Template Reference

Queue with maximum bytes of storage. More...

#include <Queue.hpp>

Inheritance diagram for Sirikata::Queue< ElementType, SizeFunctorType >:

Collaboration diagram for Sirikata::Queue< ElementType, SizeFunctorType >:

List of all members.

Public Types
typedef ElementType	Type
Public Member Functions
	Queue (uint32 max_size)
	~Queue ()
QueueEnum::PushResult	push (const ElementType &msg)
const ElementType &	front () const
ElementType &	front ()
ElementType	pop ()
bool	empty () const
uint32	maxSize () const
uint32	size () const
Private Attributes
std::deque< ElementType >	mElements
SizeFunctorType	mSizeFunctor
uint32	mMaxSize
uint32	mSize

---

Detailed Description

template<typename ElementType, typename SizeFunctorType = MethodSizeFunctor<ElementType>>
class Sirikata::Queue< ElementType, SizeFunctorType >

Queue with maximum bytes of storage.

---

Member Typedef Documentation

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

typedef ElementType Sirikata::Queue< ElementType, SizeFunctorType >::Type

Reimplemented from Sirikata::AbstractQueue< ElementType >.

---

Constructor & Destructor Documentation

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

Sirikata::Queue< ElementType, SizeFunctorType >::Queue

(

uint32

max_size

)

[inline]

References Sirikata::Queue< ElementType, SizeFunctorType >::mMaxSize, and Sirikata::Queue< ElementType, SizeFunctorType >::mSize.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

Sirikata::Queue< ElementType, SizeFunctorType >::~Queue

(

)

[inline]

---

Member Function Documentation

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

bool Sirikata::Queue< ElementType, SizeFunctorType >::empty

(

)

const [inline, virtual]

Implements Sirikata::AbstractQueue< ElementType >.

References Sirikata::Queue< ElementType, SizeFunctorType >::mElements.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

const ElementType& Sirikata::Queue< ElementType, SizeFunctorType >::front

(

)

const [inline, virtual]

Implements Sirikata::AbstractQueue< ElementType >.

References Sirikata::Queue< ElementType, SizeFunctorType >::mElements.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

ElementType& Sirikata::Queue< ElementType, SizeFunctorType >::front

(

)

[inline, virtual]

Implements Sirikata::AbstractQueue< ElementType >.

References Sirikata::Queue< ElementType, SizeFunctorType >::mElements.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

uint32 Sirikata::Queue< ElementType, SizeFunctorType >::maxSize

(

)

const [inline]

References Sirikata::Queue< ElementType, SizeFunctorType >::mMaxSize.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

ElementType Sirikata::Queue< ElementType, SizeFunctorType >::pop

(

)

[inline, virtual]

Reimplemented from Sirikata::AbstractQueue< ElementType >.

References Sirikata::Queue< ElementType, SizeFunctorType >::mElements, Sirikata::Queue< ElementType, SizeFunctorType >::mSize, and Sirikata::Queue< ElementType, SizeFunctorType >::mSizeFunctor.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

QueueEnum::PushResult Sirikata::Queue< ElementType, SizeFunctorType >::push

(

const ElementType &

msg

)

[inline, virtual]

Implements Sirikata::AbstractQueue< ElementType >.

References Sirikata::Logging::fatal, Sirikata::Queue< ElementType, SizeFunctorType >::mElements, Sirikata::Queue< ElementType, SizeFunctorType >::mMaxSize, Sirikata::Queue< ElementType, SizeFunctorType >::mSize, Sirikata::Queue< ElementType, SizeFunctorType >::mSizeFunctor, Sirikata::QueueEnum::PushExceededMaximumSize, Sirikata::QueueEnum::PushSucceeded, and SILOG.

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

uint32 Sirikata::Queue< ElementType, SizeFunctorType >::size

(

)

const [inline, virtual]

Implements Sirikata::AbstractQueue< ElementType >.

References Sirikata::Queue< ElementType, SizeFunctorType >::mSize.

---

Member Data Documentation

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

std::deque<ElementType> Sirikata::Queue< ElementType, SizeFunctorType >::mElements [private]

Referenced by Sirikata::Queue< ElementType, SizeFunctorType >::empty(), Sirikata::Queue< ElementType, SizeFunctorType >::front(), Sirikata::Queue< ElementType, SizeFunctorType >::pop(), and Sirikata::Queue< ElementType, SizeFunctorType >::push().

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

uint32 Sirikata::Queue< ElementType, SizeFunctorType >::mMaxSize [private]

Referenced by Sirikata::Queue< ElementType, SizeFunctorType >::maxSize(), Sirikata::Queue< ElementType, SizeFunctorType >::push(), and Sirikata::Queue< ElementType, SizeFunctorType >::Queue().

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

uint32 Sirikata::Queue< ElementType, SizeFunctorType >::mSize [private]

Referenced by Sirikata::Queue< ElementType, SizeFunctorType >::pop(), Sirikata::Queue< ElementType, SizeFunctorType >::push(), Sirikata::Queue< ElementType, SizeFunctorType >::Queue(), and Sirikata::Queue< ElementType, SizeFunctorType >::size().

template<typename ElementType , typename SizeFunctorType = MethodSizeFunctor<ElementType>>

SizeFunctorType Sirikata::Queue< ElementType, SizeFunctorType >::mSizeFunctor [private]

Referenced by Sirikata::Queue< ElementType, SizeFunctorType >::pop(), and Sirikata::Queue< ElementType, SizeFunctorType >::push().

---

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

• libcore/include/sirikata/core/queue/Queue.hpp